Campaign templates

Campaign templates allow you to store all of the settings used when creating a campaign.

Fields

class CampaignTemplate

created_at: datetime: The campaign template’s creation date and time.

description: string: The campaign template’s description.

id: integer: The campaign template’s unique ID.

kind: integer

The type of campaign.

0 = phone campaign
1 = SMS broadcast campaign
2 = voice broadcast campaign
3 = voicemail drop campaign
4 = e-mail broadcast campaign
5 = letter broadcast campaign
6 = data enrichment campaign
100 = no action campaign

name: string: The campaign template’s name.

team: integer: The campaign template’s team.

API

GET /j/campaign_templates

Retrieves the list of campaign templates.

Example request:

GET /j/campaign_templates HTTP/1.1
Authorization: Bearer 0a1b2c3d4e5f

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
   {
      "created_at": "2016-11-04T19:11:34.985Z",
      "description": "Some description",
      "id": 1,
      "kind": 0,
      "name": "Phone template",
      "team": 1,
   },
   {
      "created_at": "2016-11-04T19:13:46.246Z",
      "description": "Other description",
      "id": 2,
      "kind": 4,
      "name": "E-mail template",
      "team": 2,
   }
]

Request Headers:

Authorization – OAuth token to authenticate

Query Parameters:

team (integer) – An optional team ID.

Response JSON Array of Objects:

created_at (datetime) – The campaign template’s creation date and time.
description (string) – The campaign template’s description.
id (integer) – The campaign template’s unique ID.
kind (integer) – The type of campaign.
name (string) – The campaign template’s name.
team (integer) – The campaign template’s team.

Status Codes:

200 OK – no error
400 Bad Request – for instance a required field is missing
403 Forbidden – you tried to access a forbidden resource, check you provided a valid OAuth token