ArchiveCampaign

POST

https://api.cbf.tcn.com/api/v0alpha/omniapi/archivecampaign

archive a campaign

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request to archive a campaign

channel_type

enum<string>

channel_type

optional

the campaign's channel type

Allowed values:

CHANNEL_TYPE_EMAILCHANNEL_TYPE_SMSCHANNEL_TYPE_CHATCHANNEL_TYPE_VOICECHANNEL_TYPE_WHATSAPP

campaign_direction

enum<string>

campaign_direction

optional

the campaign direction

Allowed values:

INBOUNDOUTBOUND

campaign_sid

integer <int64> | string

campaign_sid

optional

the campaign identifier

Example

{
    "channel_type": "CHANNEL_TYPE_EMAIL",
    "campaign_direction": "INBOUND",
    "campaign_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/omniapi/archivecampaign' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel_type": "CHANNEL_TYPE_EMAIL",
    "campaign_direction": "INBOUND",
    "campaign_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Response to archive a campaign

reference_id

string

reference_id

optional

send back ghost notifier referenceID

Example

{
    "reference_id": "string"
}

🔴500Server Error

Modified at 2025-07-10 17:42:28

EvaluateObservedHolidays

CreateCampaign