Remove contacts from a campaign
curl --request DELETE \
--url https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contactIds": [
"6806d18d5f0c4a4f2f780001"
]
}
'const options = {
method: 'DELETE',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({contactIds: ['6806d18d5f0c4a4f2f780001']})
};
fetch('https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts"
payload = { "contactIds": ["6806d18d5f0c4a4f2f780001"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"contactIds": [
"6806d18d5f0c4a4f2f780001"
]
}'{
"accepted": true,
"campaignId": "<string>",
"removedContactIds": [
"<string>"
],
"skippedContactIds": [
"<string>"
]
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Campaigns
Remove contacts from campaign
Exit up to 50 contacts from a sequence and inspect skipped contacts.
DELETE
/
campaigns
/
{campaignId}
/
contacts
Remove contacts from a campaign
curl --request DELETE \
--url https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contactIds": [
"6806d18d5f0c4a4f2f780001"
]
}
'const options = {
method: 'DELETE',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({contactIds: ['6806d18d5f0c4a4f2f780001']})
};
fetch('https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts"
payload = { "contactIds": ["6806d18d5f0c4a4f2f780001"] }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)$headers=@{}
$headers.Add("x-api-key", "<api-key>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://my.jobin.cloud/api/openapi/v1/campaigns/{campaignId}/contacts' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"contactIds": [
"6806d18d5f0c4a4f2f780001"
]
}'{
"accepted": true,
"campaignId": "<string>",
"removedContactIds": [
"<string>"
],
"skippedContactIds": [
"<string>"
]
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"statusCode": 429,
"error": "Too Many Requests",
"message": "<string>",
"retryAfterSeconds": 123
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}{
"code": "UNHANDLED_EXCEPTION",
"error": "Unexpected error"
}Send 1–50 unique contact identifiers in the JSON body. Contacts outside this campaign are reported
as skipped.
Rate limit: 10 requests/minute per endpoint and workgroup. Details.
Authorizations
Primary public authentication method. Create keys in Jobin.cloud under Workgroups > Integrations > Custom integration.
Path Parameters
Body
application/json
Contacts to exit from this campaign. Contacts not currently assigned to the campaign are reported as skipped.
Required array length:
1 - 50 elementsPattern:
^[a-fA-F0-9]{24}$