curl --request POST \
--url https://{subdomain}.conveyour.com/api/triggers/reset \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"trigger_id": "<string>",
"contact_ids": [
"<string>"
],
"contact_id": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trigger_id: '<string>', contact_ids: ['<string>'], contact_id: '<string>'})
};
fetch('https://{subdomain}.conveyour.com/api/triggers/reset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trigger_id: '<string>', contact_ids: ['<string>'], contact_id: '<string>'})
};
fetch('https://{subdomain}.conveyour.com/api/triggers/reset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/triggers/reset"
payload = {
"trigger_id": "<string>",
"contact_ids": ["<string>"],
"contact_id": "<string>"
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/triggers/reset",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'trigger_id' => '<string>',
'contact_ids' => [
'<string>'
],
'contact_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "trigger reset action applied with success",
"data": {
"success": {
"CONTACT_ID_1": "trigger reset with success for contact"
},
"errors": {}
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Reset a trigger
Resets one or more contacts for a trigger so it can re-fire for them.
Reset contacts so a trigger can re-fire for them
Permission: requires campaigns.
curl --request POST \
--url https://{subdomain}.conveyour.com/api/triggers/reset \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"trigger_id": "<string>",
"contact_ids": [
"<string>"
],
"contact_id": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trigger_id: '<string>', contact_ids: ['<string>'], contact_id: '<string>'})
};
fetch('https://{subdomain}.conveyour.com/api/triggers/reset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({trigger_id: '<string>', contact_ids: ['<string>'], contact_id: '<string>'})
};
fetch('https://{subdomain}.conveyour.com/api/triggers/reset', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/triggers/reset"
payload = {
"trigger_id": "<string>",
"contact_ids": ["<string>"],
"contact_id": "<string>"
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/triggers/reset",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'trigger_id' => '<string>',
'contact_ids' => [
'<string>'
],
'contact_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "trigger reset action applied with success",
"data": {
"success": {
"CONTACT_ID_1": "trigger reset with success for contact"
},
"errors": {}
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
Response
Success.
The common response envelope shared by all ConveYour endpoints.
ok on success, failed on error.
ok, failed Human-readable description of the result.
Per-contact outcome of a trigger reset. Returned only when at least one contact succeeded — an all-failure run returns an error instead.
Show child attributes
Show child attributes