Retrieving the list of partner campaigns for a specific invitation type

The list is paginated by 50 items and is ordered alphabetically by name. It starts at page 1. Thus, each partner campaign represents a different partner.

JSON

Request

GET /api/v1/events/{event_id}/invitation_types/{invitation_type_id}/partner_campaigns.json?auth_token=YOUR_API_TOKEN&page={number}

Response

// 200 OK
[
  {
    // the first partner campaign
  },
  {
    // the second partner campaign
  },
  ...
]

Creating a partner campaign

partner_id and quota are the only mandatory fields. partner_id must be unique within the invitation type for a specific partner. quota is an integer greater than or equal to 0 representing the number of emails the partner campaigns can send. If your event is attached to an Eventmaker event, you can also specify promo code fields in order to create a promo code in Eventmaker that will be usable by your partner campaign.

JSON

Request

POST /api/v1/events/{event_id}/invitation_types/{invitation_type_id}/partner_campaigns.json?auth_token=YOUR_API_TOKEN
Content-Type: application/json; charset=utf-8
{
  "partner_campaign": {
    "partner_id": "<PARTNER_ID>",
    "quota": 50,
    "mobicheckin_promo_code_amount": 50,
    "mobicheckin_promo_code_percentage_of_total": false,
    "mobicheckin_promo_code_text": "CODE124",
    "mobicheckin_promo_code_max_usage": 3
  }
}

Response

// 201 CREATED
{
  "_id":"<IDENTIFIER>",
  "created_at":"2019-03-01T09:00:00.262Z"
  "from_mailer":null,
  "invitation_type_id":"<INVITATION_TYPE_ID>",
  "metadata":{},
  "mobicheckin_promo_code_amount":50,
  "mobicheckin_promo_code_id":"<EVENTMAKER_PROMO_CODE_ID>",
  "mobicheckin_promo_code_max_usage":3,
  "mobicheckin_promo_code_percentage_of_total":false,
  "mobicheckin_promo_code_text":"CODE124",
  "nb_email_sent":0,
  "quota":50,
  "reply_to":"",
  "updated_at":"2019-03-01T09:00:00.262Z"
}

Deleting a partner campaign

The partner is then no longer attached to the invitation type.

JSON

Request

DELETE /api/v1/events/{event_id}/invitation_types/{invitation_type_id}/partner_campaigns/{id}.json?auth_token=YOUR_API_TOKEN

Response

// 200 OK