Success responses
The description and the listed status codes below indicate that an action requested by the client was successfully processed.
The successful responses will have status codes in the 200-299
range and have relevant response content where required. However, 204 No Content
and 205 Reset Content
status codes won't contain a response content.
Response Style Properties
Field | Description | Properties |
---|---|---|
operation_id | A descriptive enough string that is linked to the operation/feature. | A required lower case snake case string |
data | A data-set that is relevant to the endpoint. | An optional single/multidimensional array |
metadata | Contains endpoint specific additional information. | An optional JSON object |
Examples
200 OK
After getting an existing resource with GET /resources/{id}
.
{
"operation_id": "resources_get",
"data": {
"id": "111-AAA-222-BBB",
"name": "Bud",
"email": "[email protected]",
"created_at": "2019-01-01T15:53:00+05:00"
}
}
201 Created
After creating a new resource with POST /resources
.
{
"operation_id": "resources_post",
"data": {
"id": "111-AAA-222-BBB"
}
}
If you have any questions, please contact us via the chatbot (bottom-right of screen 👉) or via a support request or check our FAQs.
Updated 7 months ago