Cancel Follow-ups
curl --request POST \
--url https://omnicommerce.ai/api/v1/follow-ups/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"followUpIds": [
"3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({followUpIds: ['3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f']})
};
fetch('https://omnicommerce.ai/api/v1/follow-ups/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.ai/api/v1/follow-ups/cancel"
payload = { "followUpIds": ["3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"operationId": "<string>",
"status": "<string>",
"data": {
"success": true,
"followUpIds": [
"<string>"
],
"succeededCount": 123,
"failedCount": 123,
"results": [
{}
]
}
}Follow Ups
Cancel Follow-ups
Cancel your follow-ups that have not fired, so they never fire. One that already fired, expired or was canceled reports why per id; another person’s follow-up reads as not found.
Returns followUpIds, succeededCount, failedCount and ordered results; ok is true only when every id was canceled.
Authorization
Requires agents:invoke.
POST
/
api
/
v1
/
follow-ups
/
cancel
Cancel Follow-ups
curl --request POST \
--url https://omnicommerce.ai/api/v1/follow-ups/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"followUpIds": [
"3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({followUpIds: ['3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f']})
};
fetch('https://omnicommerce.ai/api/v1/follow-ups/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.ai/api/v1/follow-ups/cancel"
payload = { "followUpIds": ["3f1c2b9e-8f0a-4c51-9d1e-2a6b7c8d9e0f"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"operationId": "<string>",
"status": "<string>",
"data": {
"success": true,
"followUpIds": [
"<string>"
],
"succeededCount": 123,
"failedCount": 123,
"results": [
{}
]
}
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Body
application/json
The follow-ups to cancel, from follow_up or list_follow_ups.
Required array length:
1 - 20 elementsPattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 120