Skip to content

Create Nurture

POST
/nurtures

Create a nurture.

sequence_kind is pinned to nurture by the app and re-validated there, so the nurture-specific channel rules fire even though this endpoint never accepts the field. user_email defaults to the identity the key was minted under; a personal nurture owned by anyone else is a 403.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Create a nurture.

sequence_kind is NOT accepted: the app pins it to nurture server-side and re-validates, which is what makes the nurture-specific channel rules fire. A client-supplied kind would either be ignored or, worse, look honoured.

object
associated_list_id
Any of:
integer
campaign_builder_campaign_id
Any of:
string
channels

Sending channels to attach.

Array<object>
object
key
additional properties
any
description
Any of:
string
finish_on_reply

Stop nurturing a contact once they reply.

boolean
default: true
include_unsubscribe_cta

Append the visible reply-opt-out CTA to email bodies.

boolean
default: true
is_shared

True makes the nurture visible org-wide. Requires an Admin or Owner role; see this router’s note on org-scope promotion.

boolean
name
required

Nurture name.

string
>= 1 characters
pinned_mailbox_id
required

The ONE mailbox this nurture sends from. Required: a nurture is pinned to a single sender so its consented audience always hears from the same address, and every email channel attached must use it. validate_nurture_rules rejects a nurture without one, so this is required here rather than left to fail deeper in.

integer
schedule_id
Any of:
string
send_in_same_thread

Keep follow-ups in the original email thread.

boolean
default: true
status

Initial status. Nurtures start drafted.

string
default: drafted
steps

Sequence steps, in order.

Array<object>
object
key
additional properties
any
textual_agent_name
Any of:
string
user_email
Any of:
string
voice_agent_name
Any of:
string
wait_for_new_contacts
boolean

Responses

201

Successful Response

object
data
required

One nurture sequence.

object
created_at
Any of:
string format: date-time
id
Any of:
string
is_shared
Any of:
boolean
name
Any of:
string
status
Any of:
string
updated_at
Any of:
string format: date-time
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string