MailcrateDocs
Journeys

Enroll a contact

POST
/public/journey/{id}/enroll

Requires the journey:write scope.

Authorization

ApiKey
headerAuthorization<token>

Api-Key mc_... — a workspace API key.

Path Parameters

id*string

Request Body

application/json
  1. body
contactId?string
email?string
data?
idempotencyKey?string
Match^[\w.\-:]+$
Lengthlength <= 200

Response Body

Example Request
curl -X POST 'https://api.mailcrate.io/public/journey/string/enroll' \  -H 'Authorization: Api-Key <api_key>' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
Empty

Trigger a journey by webhook POST

Enrolls a contact into the journey that owns the trigger URL. Needs no API key: the token in the path is the credential, and calls are rate limited per IP address. Copy the URL from the journey's webhook trigger in the app.

Exit a contact POST

Ends the contact's live enrollments in this journey. Calling it for a contact who is not enrolled is not an error. Requires the `journey:write` scope.