Create Sequence

Create a new outreach sequence.

POST/api/v1/marketing/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/marketing/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: CREATE_SEQUENCE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "trigger": "MANUAL"
  }'

Authorization

Minimum role: ManagerThe caller must hold this role or a higher one.
Action: CREATE_SEQUENCE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be CREATE_SEQUENCE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

namestringRequired
No description yet.
minimum length 1
tenant_iduuidRequired
No description yet.
triggerenumRequired
No description yet.
Allowed values
- MANUAL
- LEAD_STAGE
- SEGMENT_JOIN
- EVENT_MATCH
account_tier_filterstring or nullOptional
No description yet.
allow_reenrollbooleanOptional
No description yet.
Default
false
exit_signalsarray of enumOptional
No description yet.
Allowed values
- REPLY
- UNSUBSCRIBE
- CONVERT
goal_conversion_metricstring or nullOptional
No description yet.
goal_kindenum or nullOptional
What marks a contact as "converted" for this sequence — reaching it can auto-exit the contact (see stop_on_goal). None on the aggregate = no goal.
Allowed values
- REPLY
- MEETING_BOOKED
- CONVERTED
reenroll_cooldown_daysinteger or nullOptional
No description yet.
segment_iduuid or nullOptional
SegmentJoin trigger config.
send_windowenumOptional
When the sequence is allowed to send. BusinessHours gates sends to the configured timezone + hour window; Anytime fires whenever a step is due.
Allowed values
- ANYTIME
- BUSINESS_HOURS
Default
ANYTIME
send_window_end_hourinteger or nullOptional
No description yet.
send_window_start_hourinteger or nullOptional
No description yet.
send_window_timezonestring or nullOptional
No description yet.
stop_on_goalbooleanOptional
No description yet.
Default
false
trigger_lead_stagestring or nullOptional
Required when trigger = LeadStage.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send CREATE_SEQUENCE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below manager or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.