Skip to main content
POST
/
clients
/
{client_id}
/
recipients
Create a recipient
curl --request POST \
  --url https://{your-workspace}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "recipient": {
    "name": "Tim Bradford",
    "email": "[email protected]"
  },
  "email": "[email protected]"
}
'
{
  "notice_code": "<string>"
}
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.

Body

application/json
​
recipient
object
required
​
email
string<email>
required

Email address of the creator.

Example:

"[email protected]"

Response

200 - application/json

OK - Request succeeded

​
notice_code
string