Sequences

Create Nurture

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.

post/nurtures

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/nurtures
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring required

Nurture name.

pinned_mailbox_idinteger 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.

descriptionstring nullable
user_emailstring nullable

Owner of the nurture. Defaults to the identity the key was minted under. A PERSONAL nurture can only be owned by the caller - supplying anyone else's address with is_shared=false is a 403.

is_sharedboolean

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

statusstring

Initial status. Nurtures start drafted.

finish_on_replyboolean

Stop nurturing a contact once they reply.

send_in_same_threadboolean

Keep follow-ups in the original email thread.

wait_for_new_contactsboolean
include_unsubscribe_ctaboolean

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

associated_list_idinteger nullable

Audience list whose contacts this nurture engages.

schedule_idstring nullable
textual_agent_namestring nullable
voice_agent_namestring nullable
stepsobject[]

Sequence steps, in order.

channelsobject[]

Sending channels to attach.

campaign_builder_campaign_idstring nullable

Studio campaign to link this nurture to.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.