Create a recipient
curl --request POST \
--url https://{your-subdomain}.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": "tim@example.com"
},
"email": "oliver@example.com"
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipient: {name: 'Tim Bradford', email: 'tim@example.com'},
email: 'oliver@example.com'
})
};
fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients"
payload = {
"recipient": {
"name": "Tim Bradford",
"email": "tim@example.com"
},
"email": "oliver@example.com"
}
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"notice_code": "<string>"
}API v1 (deprecated)
Create recipient
Create a recipient.
POST
/
clients
/
{client_id}
/
recipients
Create a recipient
curl --request POST \
--url https://{your-subdomain}.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": "tim@example.com"
},
"email": "oliver@example.com"
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipient: {name: 'Tim Bradford', email: 'tim@example.com'},
email: 'oliver@example.com'
})
};
fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetoinvoice.com/api/external/v1/clients/{client_id}/recipients"
payload = {
"recipient": {
"name": "Tim Bradford",
"email": "tim@example.com"
},
"email": "oliver@example.com"
}
headers = {
"X-Api-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"notice_code": "<string>"
}Deprecated: This is a v1 endpoint and is deprecated. Please use the
v2 API instead. v1 endpoints will be removed
in a future release.
Replace
Learn how to find your subdomain in Workspace subdomain.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Path Parameters
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
Response
200 - application/json
OK - Request succeeded