Create or update a sequence.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
Sequence data
Request body for creating or updating a sequence
Safety flag. Required to be true if "steps" is provided but keeps none of the existing steps (e.g. an empty array); otherwise the request is rejected to prevent accidentally wiping every step.
CRM integration ID to sync to (used only when crmSyncEnabled is true). To find valid IDs, call crm_getCrmIntegrations.
Enable syncing replies/outcomes to a CRM. When true, also set crmIntegrationId.
Sequence description
Sequence ID. Provide to update an existing sequence; omit to create a new one.
Append a custom opt-out line to the end of each email, where the unsubscribe link goes. Independent of includeUnsubscribeLink — use it in place of or in addition to the link, and it is also included on text-only emails (which have no link). When true and unsubscribeText is blank, the default line is used. Defaults to false.
FALLBACK ONLY. LinkedIn account integration IDs used for a member whose selected sender profile has no linkedinIntegrationId of its own. If your sender profiles already have LinkedIn attached, leave this empty. To find valid IDs, call integrations_getIntegrationsByType with path integration_type=browser_session and query type=linkedin_login.
Sequence name. Required when creating (no id); optional on update.
Company user IDs (uids) who should receive sequence notifications. To find valid IDs, call company_users_getCompanyUsers.
Update only the fields present in this body and leave all omitted fields untouched. Recommended for AI agents making targeted edits so they never reset unrelated settings. Ignored when creating a new sequence. Defaults to false (full replace).
FALLBACK ONLY. Twilio/phone integration IDs for SMS/voice steps, used when the selected sender profile has no phoneIntegrationId. If your sender profiles already have phone attached, leave this empty. To find valid IDs, call integrations_getIntegrationsByType with path integration_type=sms.
FALLBACK ONLY. Sending phone numbers (E.164) paired with the fallback phoneIntegrationIds, used when the sender profile has no phone number. To find available numbers for a phone integration, call integrations_getTwilioPhoneNumbers with that integration_id.
Deprecated single sender profile ID; prefer senderProfileIds. To find valid IDs, call sequences_listProfiles.
PRIMARY channel configuration. Sender profile IDs to send as; each profile already carries its own email account, LinkedIn account, phone integration + number, voice, and agent, so usually this is the only channel field you need to set. To find valid IDs (and to see which channels each profile already has), call sequences_listProfiles. To attach a missing channel, edit the sender profile via sequences_updateProfile rather than setting the sequence-level fallbacks below.
Array of sequence step configurations. WARNING: this REPLACES the full step list — any existing step not included here is removed. Omit this key entirely to leave steps unchanged. To edit, add, or delete a single step, prefer the /sequences//steps endpoints instead.
The custom opt-out text shown when includeUnsubscribeText is true. Leave blank to use the default: 'If this is not relevant, simply reply "stop".' Has no effect unless includeUnsubscribeText is true.
FALLBACK ONLY. Voice ID for voice-message steps, used when the selected sender profile has no voiceId. To find valid IDs, call voices_listVoices.
Response
Created sequence
Sequence response
Sequence object

