latestOpenAPI 3.0.02026-08-1535120202.6 KB
f59881dadecd
Designations
Create multiple designations
Use this request to create up to 100 designations in your account in a single call. Each item is processed individually, and the response contains a per-item result with either the created designation or an error.
post/v1/designations/batch/create
Request body
Example request
{
"items": [
{
"name": "My Designation",
"code": "Code-1"
}
],
"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"
}
}
],
"status": "complete"
}