Sign in

v1

latestSwagger 2.02026-08-06114161439.7 KB
campaign

Returns a specific campaign record referenced by the ID given

Retrieves detailed configuration for a specific campaign by ID. Returns campaign settings including tracking numbers, routing rules, business hours, geographic targeting, and performance analytics configuration.

get/campaign

Query parameters

idinteger required

Identification ID of the record to be returned. Required integer.

display_referralboolean

Boolean toggle. If true, include referral service data in the response. Default false.

Response

Campaign configuration with settings, tracking numbers, and routing rules

campaign_idinteger

Unique identifier for the campaign this call was attributed to. Integer.

campaign_namestring required

Human-readable campaign name. String.

campaign_ext_idstring

Customer-provided external identifier for the campaign. Integer.

campaign_status'active' | 'inactive' | 'suspended'

The current status of the campaign. Type: enum (string); Allowed values: active, inactive, suspended.

campaign_createdstring date-time

The date and time of when the campaign record was created. Type: string (date-time).

campaign_modifiedstring date-time

A date and time stamp of the last time anything was modified on campaign. Type: string (date-time).

campaign_start_datestring date-time required

The date and time that the campaign is activated. Type: string (date-time).

campaign_end_datestring date-time

The date and time at which the campaign will end. Type: string (date-time).

campaign_owner_user_idinteger required

The unique ID of the user that is the owner of the campaign. Type: integer (int32).

group_idinteger required

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

owner_fnamestring

The first name of the campaign owner. Type: string.

owner_lnamestring

The last name of the campaign owner. Type: string.