Profile

Get business profile

get
Authorizations
HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters
organizationIdstringRequired

The organization ID

Responses
200

OK

application/json
get
/organizations/{organizationId}/profile

Update business profile

patch
Authorizations
HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters
organizationIdstringRequired

The organization ID

Body
idstring · uuidOptional

The profile ID

versionintegerOptional

The version of the business profile

namestring · max: 256Optional

The name under which this business is commonly referred to.

domainstring · domain · max: 253Optional

Domain name.

Example: example.comPattern: ^(([a-zA-Z0-9]([a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,})?$
legalNamestring · max: 256Optional

The name under which this business is registered.

logoUrlstringOptionalPattern: ^|https://
Responses
200

OK

application/json
patch
/organizations/{organizationId}/profile

Last updated

Was this helpful?