Crm ยท Social posts
Delete scheduled social post
Deletes a scheduled social post for an organization and attempts to remove its media. It takes organizationId and postId and returns postId on success.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access with the
social.removepermission is required.
Request
Path parameters
-
organizationIdidrequired -
postIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request DELETE 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialPosts/YOUR_POST_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialPosts/YOUR_POST_ID", {
method: "DELETE",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'DELETE',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/crm/communication/socialPosts/YOUR_POST_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
postIdid
Response200
{
"postId": "000000000000000000000001"
}
What else happens
- Deletes the matching scheduled post from
socialPosts. - After deletion, attempts to remove the post's media folder. A media removal failure is caught.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 409 | This post is no longer scheduled. It may already be publishing. | If no matching scheduled post is deleted, the endpoint returns HTTP 409 with key socialPost.notScheduled. |
Errors nearly every request can meet are listed under Errors.