Chilkat Online Tools

Unicode C++ / Braze Endpoints / Delete Scheduled API Triggered Campaigns

Back to Collection Items

void ChilkatSample(void)
    {
    json.UpdateString(L"campaign_id",L"campaign_identifier");    json.UpdateString(L"schedule_id",L"schedule_identifier");    http.put_AuthToken(L"{{api_key}}");
    }

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{api_key}}"
	-d '{
  "campaign_id": "campaign_identifier",
  "schedule_id": "schedule_identifier"
}'
https://rest.iad-01.braze.com/campaigns/trigger/schedule/delete

Postman Collection Item JSON

{
  "name": "Delete Scheduled API Triggered Campaigns",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{api_key}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"campaign_id\": \"campaign_identifier\",\n  \"schedule_id\": \"schedule_identifier\"\n}\n"
    },
    "url": {
      "raw": "https://{{instance_url}}/campaigns/trigger/schedule/delete",
      "protocol": "https",
      "host": [
        "{{instance_url}}"
      ],
      "path": [
        "campaigns",
        "trigger",
        "schedule",
        "delete"
      ]
    },
    "description": "The delete schedule endpoint allows you to cancel a message that you previously scheduled API Triggered Campaigns before it has been sent.\n\nScheduled messages or triggers that are deleted very close to or during the time they were supposed to be sent will be updated with best efforts, so last second deletions could be applied to all, some, or none of your targeted users.\n\n### Request Parameters\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n| `campaign_id`|Required|String| See campaign identifier|\n| `schedule_id` | Required | String | The schedule_id to delete (obtained from the response to create schedule) |\n\n## Request Components\n- [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)"
  },
  "response": [
  ]
}