Add recipients
curl --request POST \
--url https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"email": "ada@lovelace.dev",
"displayName": "Ada Lovelace",
"personalization": {
"firstName": "Ada",
"company": "Lovelace Labs"
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: [
{
email: 'ada@lovelace.dev',
displayName: 'Ada Lovelace',
personalization: {firstName: 'Ada', company: 'Lovelace Labs'}
}
]
})
};
fetch('https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients"
payload = { "recipients": [
{
"email": "ada@lovelace.dev",
"displayName": "Ada Lovelace",
"personalization": {
"firstName": "Ada",
"company": "Lovelace Labs"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"added": 47,
"duplicates": 2,
"suppressed": 1,
"invalid": 0,
"totalRecipients": 120
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}email
Add recipients
Add recipients to a managed email campaign.
POST
/
email
/
campaigns
/
{campaignId}
/
recipients
Add recipients
curl --request POST \
--url https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"email": "ada@lovelace.dev",
"displayName": "Ada Lovelace",
"personalization": {
"firstName": "Ada",
"company": "Lovelace Labs"
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: [
{
email: 'ada@lovelace.dev',
displayName: 'Ada Lovelace',
personalization: {firstName: 'Ada', company: 'Lovelace Labs'}
}
]
})
};
fetch('https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.dench.com/api/v1/email/campaigns/{campaignId}/recipients"
payload = { "recipients": [
{
"email": "ada@lovelace.dev",
"displayName": "Ada Lovelace",
"personalization": {
"firstName": "Ada",
"company": "Lovelace Labs"
}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"added": 47,
"duplicates": 2,
"suppressed": 1,
"invalid": 0,
"totalRecipients": 120
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}Authorizations
DenchApiKeyAgentSession
Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.
Path Parameters
Body
application/json
Up to 500 recipients per call.
Maximum array length:
500Show child attributes
Show child attributes
⌘I