Skip to navigation
APIPay Ops endpointsBusinesses

Update a business-person link

Beta
View as MarkdownOpen in Claude

Applies a partial update to a business-person link. Send only the fields you want to change; omitted fields are kept.

Authentication

AuthorizationBearer

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

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

personReferencestringRequired
The person reference.

Request

This endpoint expects an object.
personTypeenumOptional
The person's role on the business.
ownershipPercentagedoubleOptional

The person’s ownership percentage (0 to 100).

isPrimaryControllerbooleanOptional
Whether the person is the business's primary controller.
isSignerbooleanOptional

Whether the person signs the business’s boarding applications. Only an owner can be the signer. Setting isSigner to true on a person with another personType returns 400 with the message Only an owner can be the signer. Changing the signer’s personType away from Owner returns the same error. Setting it to true removes it from every other person linked to the business. Setting it to false leaves the business with no signer until you set another one.

titlestring or nullOptional<=100 characters

The person’s job title at this business, from 1 to 100 characters. Updating it changes the title for this business only. Omitting it, or sending null or a blank value, keeps the stored title. You can replace a title, but you can’t clear it.

primaryEmailstringOptional
The relationship's primary email address.
secondaryEmailstringOptional
The relationship's secondary email address.
primaryPhoneNumberstringOptional
The relationship's primary phone number.
secondaryPhoneNumberstringOptional
The relationship's secondary phone number.
billingAddressobjectOptional
The billing address for the relationship.
mailingAddressobjectOptional
The mailing address for the relationship.

Response

The link was updated.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null

The business-person link.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error