Skip to main content
Start a journey execution
curl --request POST \
  --url https://integration.getmateo.com/api/v1/journey_execution \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "journey_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "birthday": "<string>",
    "campaign_messages_this_month": 123,
    "city": "<string>",
    "country": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "created_by_api_token_id": "<string>",
    "created_by_employee_id": "<string>",
    "created_by_import_id": "<string>",
    "created_by_rule_id": "<string>",
    "deleted_at": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "email": "<string>",
    "email_health": "healthy",
    "email_marketing_messages_this_month": 123,
    "email_marketing_opt_in": true,
    "email_transactional_opt_in": "legitimate_interest",
    "external_id": "<string>",
    "facebook": "<string>",
    "facebook_health": "healthy",
    "facebook_marketing_messages_this_month": 123,
    "facebook_marketing_opt_in": true,
    "facebook_transactional_opt_in": "legitimate_interest",
    "fts": "<unknown>",
    "full_name": "<string>",
    "google_business_messaging": "<string>",
    "google_business_messaging_health": "healthy",
    "google_business_messaging_marketing_messages_this_month": 123,
    "google_business_messaging_marketing_opt_in": true,
    "google_business_messaging_transactional_opt_in": "legitimate_interest",
    "id": "<string>",
    "influenced_revenue": 123,
    "instagram": "<string>",
    "instagram_health": "healthy",
    "instagram_marketing_messages_this_month": 123,
    "instagram_marketing_opt_in": true,
    "instagram_transactional_opt_in": "legitimate_interest",
    "is_blocked": true,
    "last_external_review_rating": 123,
    "last_interaction_at": "<string>",
    "last_internal_review_rating": 123,
    "last_outbound_at": "<string>",
    "last_review_rating": 123,
    "latest_marketing_opt_in_request_sent_at": "<string>",
    "latest_review_request_message_sent_at": "<string>",
    "marketing_opt_in": true,
    "number_of_marketing_opt_in_requests": 123,
    "organisation_id": "<string>",
    "postal": "<string>",
    "postal_health": "healthy",
    "postal_marketing_messages_this_month": 123,
    "postal_marketing_opt_in": true,
    "postal_messages_this_month": 123,
    "postal_transactional_opt_in": "legitimate_interest",
    "review_request_message_count": 123,
    "salutation": "<string>",
    "secondary_external_id": "<string>",
    "sms": "<string>",
    "sms_health": "healthy",
    "sms_marketing_messages_this_month": 123,
    "sms_marketing_opt_in": true,
    "sms_transactional_opt_in": "legitimate_interest",
    "transactional_opt_in": "legitimate_interest",
    "updated_at": "<string>",
    "updated_by": "<string>",
    "updated_by_api_token_id": "<string>",
    "updated_by_employee_id": "<string>",
    "updated_by_import_id": "<string>",
    "updated_by_rule_id": "<string>",
    "whatsapp": "<string>",
    "whatsapp_health": "healthy",
    "whatsapp_marketing_messages_this_month": 123,
    "whatsapp_marketing_opt_in": true,
    "whatsapp_transactional_opt_in": "legitimate_interest",
    "zipcode": "<string>"
  },
  "context": {}
}
'
{
  "success": true,
  "journey_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
journey_id
string<uuid>
required

The journey ID to execute

contact
object
required

Contact details to import or find

context
object

Context data for the journey execution, must match the schema defined in the journey trigger node

Response

Journey execution started successfully

success
boolean
required
journey_execution_id
string<uuid>
required
contact_id
string<uuid>
required