Skip to main content
DELETE
/
clients
/
{client_id}
/
recipients
/
{recipient_id}
Delete a recipient
curl --request DELETE \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients/{recipient_id} \
  --header 'X-Api-Key: <x-api-key>'
{
  "notice_code": "<string>",
  "recipient": {
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deleted": true,
    "name": "<string>",
    "creator_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "[email protected]",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

​
client_id
string
required

Unique ID of the client for which you want to retrieve or update details. Refer to Getting the Client ID section for detailed instructions.

​
recipient_id
string
required

Unique Id of recipient that you want to delete. Refer to Getting the Recipient ID section for detailed instructions.

Response

200 - application/json

OK - Request succeeded

​
notice_code
string
​
recipient
object