LettrLabs API
API ReferenceOrders

Delete recipients associated with a specific order

Delete recipients associated with a specific order.

DELETE
/v1/order/{id}/recipients

Delete recipients associated with a specific order.

X-API-KEY<token>

In: header

Path Parameters

id*integer

Order id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

recipientsIds*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/order/0/recipients" \  -H "Content-Type: application/json" \  -d '{    "recipientsIds": [      0    ]  }'
{  "payload": {    "orderId": 0,    "status": "string"  },  "errors": [    "string"  ],  "errorDetails": [    null  ],  "warnings": [    "string"  ],  "hasErrors": true,  "hasWarnings": true}
{  "payload": {    "orderId": 0,    "status": "string"  },  "errors": [    "string"  ],  "errorDetails": [    null  ],  "warnings": [    "string"  ],  "hasErrors": true,  "hasWarnings": true}
{  "payload": {    "orderId": 0,    "status": "string"  },  "errors": [    "string"  ],  "errorDetails": [    null  ],  "warnings": [    "string"  ],  "hasErrors": true,  "hasWarnings": true}
{  "payload": {    "orderId": 0,    "status": "string"  },  "errors": [    "string"  ],  "errorDetails": [    null  ],  "warnings": [    "string"  ],  "hasErrors": true,  "hasWarnings": true}