MOmonaco
Campaigns

Enroll Contacts in a Campaign

Changed on

Enrolls contacts into a campaign by creating a new audience named audience_name, attaching it to the campaign, and adding the contacts to it. The campaign must be active or paused.

This always creates a new audience. Audiences can be shared across campaigns, so a contact added to one is enrolled in every campaign using it.

post/v1/campaigns/{campaign_id}/enroll

Request

  • Base URL
    https://api.monaco.com
  • URL
    https://api.monaco.com/v1/campaigns/{campaign_id}/enroll
  • Auth
    none declared

Path parameters

campaign_idstring uuid required

Request body

audience_namestring required

Name for the new audience created to hold these contacts; pick something short and relevant to the enrollment. Must be unique within the organization — a duplicate name is rejected, so vary it and retry.

contact_idsstring[] required

IDs of the contacts to enroll in the campaign

Example request

{
  "audience_name": "Q3 Enterprise Outbound — July batch",
  "contact_ids": [
    "550e8400-e29b-41d4-a716-446655440020"
  ]
}

Response

Successful Response

Example response

{
  "data": {
    "success_count": 2,
    "failure_count": 1,
    "failure_reasons": [
      {
        "code": "contact_has_active_sequence",
        "description": "existing active sequence",
        "count": 1
      }
    ]
  }
}

Changes