Update profile

PATCH

https://api.sureshake.com/v2/entities/{id}/profile

Path parameters

id
string
required
format: uuid

Request body JSON

entityId
optional
string
format: uuid
legalName
optional
string
minLength: 1
tagline
optional
string
or null
physicalAddress
optional
map of
unknown
mailingAddress
optional
map of
unknown
or null
phoneNumber
optional
string
or null
email
optional
string
or null
format: email
websiteUrl
optional
Any of the following:
any of
Any of the following:
Option 1
string
string
}
socialLinks
optional
map of
unknown
or null
industryCode
optional
string
or null
naicsCodePrimary
optional
string
or null
naicsCodeSecondary
optional
array of
string
or null
sicCodePrimary
optional
string
or null
establishmentDate
optional
string
or null
foundedYear
optional
integer
or null
maximum: 2100 · minimum: 1800
legalStructure
optional
string
or null
taxId
optional
string
or null
employeeCount
optional
integer
or null
minimum: 0
companySizeCategory
optional
string
or null
annualRevenueRange
optional
string
or null
exactAnnualRevenue
optional
or null
Any of the following:
number
string
}
businessDescription
optional
string
or null
audienceDashboardLayout
optional
string
or null
marketsServed
optional
array of
string
or null
productsServices
optional
array of
string
or null
certifications
optional
array of
string
or null
companyValues
optional
unknown
or null
achievements
optional
array of
string
or null
consentPublicRecords
optional
boolean
profileTier
optional
basic
or
premium
verificationStatus
optional
unverified
or
pending
or
verified

Returns

200

Default Response

JSON

entityId
string
required
format: uuid
profile
object
or null
required
- entityId
  string
  required
  format: uuid
- legalName
  string
  required
  minLength: 1
- physicalAddress
  map of
  unknown
  required
- consentPublicRecords
  boolean
  required
- tagline
  optional
  string
  or null
- mailingAddress
  optional
  map of
  unknown
  or null
- phoneNumber
  optional
  string
  or null
- email
  optional
  string
  or null
  format: email
- websiteUrl
  optional
  Any of the following:
  any of
  Any of the following:
  Option 1
  string
  string
- socialLinks
  optional
  map of
  unknown
  or null
- industryCode
  optional
  string
  or null
- naicsCodePrimary
  optional
  string
  or null
- naicsCodeSecondary
  optional
  array of
  string
  or null
- sicCodePrimary
  optional
  string
  or null
- establishmentDate
  optional
  string
  or null
- foundedYear
  optional
  integer
  or null
  maximum: 2100 · minimum: 1800
- legalStructure
  optional
  string
  or null
- taxId
  optional
  string
  or null
- employeeCount
  optional
  integer
  or null
  minimum: 0
- companySizeCategory
  optional
  string
  or null
- annualRevenueRange
  optional
  string
  or null
- exactAnnualRevenue
  optional
  or null
  Any of the following:
  number
  string
- businessDescription
  optional
  string
  or null
- audienceDashboardLayout
  optional
  string
  or null
- marketsServed
  optional
  array of
  string
  or null
- productsServices
  optional
  array of
  string
  or null
- certifications
  optional
  array of
  string
  or null
- companyValues
  optional
  unknown
  or null
- achievements
  optional
  array of
  string
  or null
- profileTier
  optional
  basic
  or
  premium
- verificationStatus
  optional
  unverified
  or
  pending
  or
  verified
- ownership
  optional
  array of
  unknown
- financialStatements
  optional
  array of
  unknown
- tradeReferences
  optional
  array of
  unknown
- createdAt
  optional
  string
  format: date-time
- updatedAt
  optional
  string
  format: date-time
- completedAt
  optional
  string
  or null
  format: date-time
}
completionScore
number
required

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

curl --request PATCH \ --url 'https://api.sureshake.com/v2/entities/<id>/profile' \ --header 'Content-Type: application/json' \ --data ' { "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "legalName": "string", "tagline": "string", "physicalAddress": { "property1": null, "property2": null }, "mailingAddress": { "property1": null, "property2": null }, "phoneNumber": "string", "email": "user@example.com", "websiteUrl": {}, "socialLinks": { "property1": null, "property2": null }, "industryCode": "string", "naicsCodePrimary": "string", "naicsCodeSecondary": [ "string" ], "sicCodePrimary": "string", "establishmentDate": "string", "foundedYear": 1800, "legalStructure": "string", "taxId": "string", "employeeCount": 0, "companySizeCategory": "string", "annualRevenueRange": "string", "exactAnnualRevenue": 0, "businessDescription": "string", "audienceDashboardLayout": "string", "marketsServed": [ "string" ], "productsServices": [ "string" ], "certifications": [ "string" ], "companyValues": null, "achievements": [ "string" ], "consentPublicRecords": true, "profileTier": "basic", "verificationStatus": "unverified" } '

{ "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "profile": { "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "legalName": "string", "tagline": "string", "physicalAddress": { "property1": null, "property2": null }, "mailingAddress": { "property1": null, "property2": null }, "phoneNumber": "string", "email": "user@example.com", "websiteUrl": {}, "socialLinks": { "property1": null, "property2": null }, "industryCode": "string", "naicsCodePrimary": "string", "naicsCodeSecondary": [ "string" ], "sicCodePrimary": "string", "establishmentDate": "string", "foundedYear": 1800, "legalStructure": "string", "taxId": "string", "employeeCount": 0, "companySizeCategory": "string", "annualRevenueRange": "string", "exactAnnualRevenue": 0, "businessDescription": "string", "audienceDashboardLayout": "string", "marketsServed": [ "string" ], "productsServices": [ "string" ], "certifications": [ "string" ], "companyValues": null, "achievements": [ "string" ], "consentPublicRecords": true, "profileTier": "basic", "verificationStatus": "unverified", "ownership": [], "financialStatements": [], "tradeReferences": [], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z" }, "completionScore": 0 }