journeys

Enroll contacts in a journey

Put contacts onto an active journey. They start receiving its programme from step one.

Send-class on purpose: enrolment starts messages over days, so journeys:enroll sits outside the agent Prepare profile the way every send scope does.

A journey that is not active answers 409 journey_not_active. Activation is a human act in the dashboard.

Up to 500 contact_ids per call; skipped counts contacts already on the journey, capped counts ids beyond the per-call limit that were not attempted.

For an organization-wide key, missing, deleted or other-business contacts count as failed; eligible contacts still enroll. Sandbox keys report eligibility counts without inserting or sending. Business-restricted keys retain whole-request contact authority checks.

unavailable_contact_ids lists the requested ids that were not eligible, deduplicated in request order, in both live and sandbox responses. It is empty when every requested contact is eligible. It does not expose why an id was unavailable or any contact data.

post/api/v1/journeys/{id}/enroll

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/journeys/{id}/enroll
  • Auth: HTTP bearer

Path parameters

idstring required

The resource's unique identifier.

Request body

contact_idsstring[] required

Example request

{
  "contact_ids": [
    "ff506e53-e2f0-4d92-884a-dab77d628bad"
  ]
}

Response

Success

okboolean required
enrollednumber required
skippednumber required
failednumber required
cappednumber required
unavailable_contact_idsstring[] required

Example response

{
  "ok": true,
  "enrolled": 1,
  "failed": 1,
  "unavailable_contact_ids": [
    "e6187c6f-a272-4854-a6fc-8adf1869ec0d"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.