Skip to main content
PUT
/
v1
/
persons
/
{personId}
/
basicInfo
Update basic information
curl --request PUT \
  --url https://api.cadanapay.com/v1/persons/{personId}/basicInfo \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "<string>",
  "phoneNumber": {
    "countryCode": "1",
    "number": "2345678901"
  },
  "metadata": {
    "customField1": "value1",
    "customField2": "value2"
  }
}
'
{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

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

​
personId
string<uuid>
required

The unique identifier for the person

Body

application/json

Update person basic info request payload

​
firstName
string
required

Person's first name

Example:

"John"

​
lastName
string
required

Person's last name

Example:

"Doe"

​
email
string
required

Person's email

​
phoneNumber
object

Person's phone number

​
metadata
object

Optional metadata you can store as key-value pairs

Example:
{
  "customField1": "value1",
  "customField2": "value2"
}

Response

Successful operation