latestOpenAPI 3.0.02026-08-1535120202.6 KB
f59881dadecd
Designations
Update multiple designations
Use this request to update up to 100 designations in your account in a single call. Only the provided fields are updated; omitted fields keep their current values. Each item is processed individually, and the response contains a per-item result with either the updated designation or an error.
post/v1/designations/batch/update
Request body
Example request
{
"items": [
{
"id": "EXXXXXXX",
"code": "Code-1",
"name": "My Designation"
}
],
"livemode": true
}Response
On success, the API returns the overall status of the bulk operation and an array with the result for each item in the request, in the same order.
Example response
{
"results": [
{
"designation": {
"account": {
"code": "Code-1",
"id": "AXXXXXXX",
"name": "Example Account"
},
"code": "Code-1",
"created_at": "2024-01-01T00:00:00.000Z",
"id": "EXXXXXXX",
"is_default": true,
"name": "My Designation",
"updated_at": "2024-01-31T00:00:00.000Z"
},
"error": {
"code": "designation_not_found",
"message": "Designation not found."
},
"id": "EXXXXXXX"
}
],
"status": "complete"
}