API
View as Markdown

Create a campaign

POSThttp://localhost:4000/api/marketingCampaigns/create

Adds a new campaign. A campaignCode is generated once the campaign is active.

Your API key needs the marketingCampaigns.MANAGE permission.

Body Params

namestringrequired

Campaign name.

typeenumrequired

Kind of campaign.

platformsarray of string

Where the campaign runs. See List campaign platforms.

statusenum

Campaign status.

startedAtstring

When the campaign started.

languageCodestring

Language code of the campaign.

countrystring

Target country.

brandIdintegerrequired

ID of the brand running the campaign.

defaultHierarchyAssigneeIdintegerrequired

ID of the team that receives new clients from this campaign.

defaultUserAssigneeIdinteger

ID of the agent who receives new clients from this campaign.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.