Simple AI Journeys API
The Journeys API from Simple AI — 2 operation(s) for journeys.
The Journeys API from Simple AI — 2 operation(s) for journeys.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/simple-ai:simple-ai-journeys-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Public API v1 Journeys API
description: 'Public API v1 requiring API keys.
**Timestamps:** All datetime fields in API responses are returned in UTC using ISO 8601 format (e.g., `2024-01-15T14:30:00Z`). When filtering by date parameters, provide timestamps in ISO 8601 format.'
version: 0.1.0
servers:
- url: https://api.usesimple.ai/api/v1
description: Production API Server
tags:
- name: Journeys
paths:
/journeys/{key}/enrollments:
post:
tags:
- Journeys
summary: Enroll a Contact in a Journey
description: Enroll a contact in an active journey. Re-sending the same idempotencyKey returns the existing enrollment instead of creating a second one. A contact the journey cannot take is returned with status skipped and the reason.
operationId: enroll_contact_journeys_key_enrollments_post
security:
- APIKeyHeader: []
parameters:
- name: key
in: path
required: true
description: The journey's key, such as `appointment-confirmations`. It is shown on the journey's Enrollment tab.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyEnrollRequest'
example:
idempotencyKey: appt-APPT02984416
contact:
phoneNumber: '+14155550100'
name: Dana Reyes
subject:
appointment_number: APPT02984416
status: Scheduled
params:
store_name: Market Street
anchorAt: '2026-10-22T14:00:00-04:00'
responses:
'200':
description: The enrollment already existed for this idempotencyKey, or the contact was skipped.
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyEnrollmentResult'
'201':
description: A new enrollment was created.
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyEnrollmentResult'
'401':
description: Authentication failed.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
'404':
description: No journey with this key, or the contact was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
'422':
description: The request is invalid, or the journey is not active (a draft, paused or archived).
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
/journeys/{key}/enrollments/cancel:
post:
tags:
- Journeys
summary: Cancel a Journey Enrollment
description: End an enrollment by the idempotencyKey it was created with or by its externalId. Every active enrollment carrying the external id ends. The enrollment ends with reason cancelled.
operationId: cancel_enrollment_journeys_key_enrollments_cancel_post
security:
- APIKeyHeader: []
parameters:
- name: key
in: path
required: true
description: The journey's key, such as `appointment-confirmations`. It is shown on the journey's Enrollment tab.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyCancelRequest'
example:
idempotencyKey: appt-APPT02984416
reason: Appointment cancelled in Salesforce
responses:
'200':
description: The enrollment ended, or had already ended.
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyEnrollmentResult'
'401':
description: Authentication failed.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
'404':
description: No journey with this key, or no enrollment with this key or external id.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
'422':
description: Send exactly one of idempotencyKey or externalId.
content:
application/json:
schema:
$ref: '#/components/schemas/PublicApiError'
components:
schemas:
JourneyCancelRequest:
type: object
additionalProperties: false
properties:
idempotencyKey:
anyOf:
- type: string
maxLength: 255
- type: 'null'
description: The key the enrollment was created with. Send this or externalId.
externalId:
anyOf:
- type: string
maxLength: 255
- type: 'null'
description: The enrollment's external id. Send this or idempotencyKey.
reason:
anyOf:
- type: string
maxLength: 500
- type: 'null'
description: Why the enrollment was cancelled. Shown in the contact's history.
title: Cancel Journey Enrollment Request
JourneyEnrollmentResult:
type: object
required:
- enrollmentId
- status
- endedReason
- skippedReason
- created
- nextTouchAt
- contact
properties:
enrollmentId:
type: string
description: The enrollment's id. Empty when the contact was skipped.
status:
type: string
enum:
- active
- ended
- skipped
description: active while the journey is working the contact, ended once it finished, skipped when the contact could not be enrolled.
endedReason:
anyOf:
- type: string
- type: 'null'
description: Why the enrollment ended, such as goal_met, opted_out, cancelled, total_cap or exhausted.
skippedReason:
anyOf:
- type: string
- type: 'null'
description: Why the contact was not enrolled, in words, such as Active in another journey.
created:
type: boolean
description: True when this request created the enrollment.
nextTouchAt:
anyOf:
- type: string
format: date-time
- type: 'null'
description: When a call or text is going out right away. Null when the next step is later; it is planned when it comes due.
contact:
anyOf:
- type: object
required:
- timezone
- timezoneSource
properties:
timezone:
anyOf:
- type: string
- type: 'null'
description: The time zone used for the contact's calling hours.
timezoneSource:
anyOf:
- type: string
- type: 'null'
description: 'Where the time zone came from: confirmed, provided, address or area_code.'
- type: 'null'
description: The contact's time zone, when known.
title: Journey Enrollment Result
JourneyEnrollRequest:
type: object
additionalProperties: false
required:
- idempotencyKey
- contact
properties:
idempotencyKey:
type: string
maxLength: 255
description: Your key for this enrollment, such as a lead or appointment id. Sending it again returns the same enrollment.
externalId:
anyOf:
- type: string
maxLength: 255
- type: 'null'
description: Another id to cancel by later. Defaults to idempotencyKey. It is also used as the contact's external id when the contact is created or updated.
contact:
description: An existing contact by id, or contact details that are created or updated by phone number.
oneOf:
- type: object
additionalProperties: false
required:
- contactId
properties:
contactId:
type: string
format: uuid
description: The contact's id.
title: Existing contact
- type: object
additionalProperties: false
required:
- phoneNumber
properties:
phoneNumber:
type: string
description: The contact's phone number, ideally in E.164 format.
name:
anyOf:
- type: string
- type: 'null'
description: The contact's name.
email:
anyOf:
- type: string
format: email
- type: 'null'
description: The contact's email address.
timezone:
anyOf:
- type: string
- type: 'null'
description: The contact's IANA time zone, such as America/Chicago. Used for calling hours ahead of the address or area code.
attributes:
type: object
additionalProperties: true
description: Contact fields to set.
title: Contact details
subject:
type: object
additionalProperties: true
description: The record this enrollment is about, such as an appointment. The journey's conditions and texts can read these fields, and calls receive them.
params:
type: object
additionalProperties: true
description: Extra parameters passed to every call the journey places for this enrollment. They are also merged into subject.
subjectKey:
anyOf:
- type: string
maxLength: 255
- type: 'null'
description: Identifies the subject. Defaults to idempotencyKey.
anchorAt:
anyOf:
- type: string
format: date-time
- type: 'null'
description: The date the journey's steps are timed from, in ISO 8601 with an offset. Overrides the anchor the journey would read from subject.
notBefore:
anyOf:
- type: string
format: date-time
- type: 'null'
description: The earliest time the first call or text may go out. Null means as soon as calling hours allow.
title: Enroll in Journey Request
PublicApiError:
type: object
required:
- status
- success
- error
- errors
properties:
status:
type: string
const: error
success:
type: boolean
const: false
error:
type: string
errors:
type: array
items:
type: string
title: Public API Error
securitySchemes:
APIKeyHeader:
type: http
scheme: bearer
description: 'Your API key, sent as `Authorization: Bearer YOUR_API_KEY`'