Update a person
Applies a partial update to a person. Send only the fields you want to change.
A person’s job title belongs to their business link, not the person. Sending title in any form, including null, returns a 400 with the message title moved to the business relationship; update it with PATCH /api/v2/businesses/{businessReference}/people/{personReference}.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Request
The person’s nationality, as a two-letter ISO 3166-1 alpha-2 country code. Nationality selects which identity number applies — US uses ssn, and any other value uses nationalIdNumber and nationalIdIssuer.
The authority that issued the national ID, used when nationality is not US.
The two-letter state code for the driver’s license.
Key-value data to merge into the person’s stored customData.
Payabli stores an owner’s answers to a boarding template’s
custom questions under the templateAnswers key.
When you update a person, Payabli merges customData into the
stored value, following JSON Merge Patch (RFC 7396). Keys you
don’t send are kept at every depth, and nested objects merge key
by key. Strings, numbers, Boolean values, and arrays replace the
stored value, and arrays aren’t merged. Send a key as null to
delete it, such as {"crmId": null}. A customData that isn’t
an object, such as an array, replaces the stored value whole.
Leave out customData to keep it as is.
The customData you send can be up to 65,536 bytes serialized.
The limit applies to the request, not to the merged result.
Government-issued identification documents for the person.
Response
A human-readable result message.