Skip to main content
PATCH
Update

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

entityId
string<uuid>
required

The unique identifier of the entity

Body

application/json

Update entity request payload (partial update)

Legal name of the entity

Example:

"Acme Corp Ghana Updated"

entityType
enum<string>

Legal structure type

Available options:
corporation,
c-corporation,
s-corporation,
partnership,
sole proprietorship,
limited liability company,
non profit,
other
Example:

"limited liability company"

address
object

Address

phoneNumber
object

Person's phone number

registrationNumber
string

Business registration number

Example:

"BN-654321"

taxId
string

Tax identification number

Example:

"TIN-210987"

incorporationDate
string

Date of incorporation (YYYY-MM-DD)

Example:

"2019-06-01"

Response

Successful operation