campaign

Create a new campaign record entry

Creates one or more new campaign records. Campaigns organize call tracking by marketing initiative, allowing you to track performance across different advertising channels and sources.

post/campaign

Request

  • Base URL
    https://apicfa.conviza.com/v2
  • URL
    https://apicfa.conviza.com/v2/campaign
  • Auth
    none declared

Request body

campaign_idinteger

Unique identifier representing the campaign

campaign_namestring required

Client defined name for the campaign

campaign_ext_idstring

A client provided identifier for the campaign

campaign_status'active' | 'inactive'

The current status of the campaign

campaign_createdstring date-time

The date and time of when the campaign record was created

campaign_modifiedstring date-time

A date and time stamp of the last time anything was modified on campaign

campaign_start_datestring date-time required

The date and time that the campaign is activated

campaign_end_datestring

The date and time at which the campaign will end or use 'never' for no end date

campaign_owner_user_idinteger required

The unique ID of the user that is the owner of the campaign

group_idinteger required

The unique group to which the campaign belongs to

campaign_usersinteger[]

Response

Newly created campaign IDs and confirmation status for each campaign

resultstring required

Outcome of the request. String, typically 'success' or 'error'.

datastring required

Response payload. Shape varies by endpoint.

entry_countinteger required

The sequential number of the entry in the submitted array. Type: integer (int32).

Changes

No recorded changes to this operation across all 2 revisions of this API.