Update Nurture

PATCH

/nurtures/{nurture_id}

• Production
• QA

Patch a nurture. Omitted fields are left alone.

exclude_unset rather than exclude_none: the app distinguishes “field absent” from “field explicitly set to null”, and collapsing the two would make it impossible to clear an optional field such as schedule_id.

Authorizations

• BearerAuth

Parameters

Path Parameters

nurture_id

required

Nurture id.

string

Nurture id.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

Patch a nurture. Every field optional; omit one to leave it unchanged.

object

appointment_id

Any of:

integer

integer

null

null

associated_list_id

Any of:

integer

integer

null

null

description

Any of:

string

string

null

null

finish_on_reply

Any of:

boolean

boolean

null

null

include_unsubscribe_cta

Any of:

boolean

boolean

null

null

is_shared

Any of:

boolean

boolean

null

null

name

Any of:

string

string

null

null

schedule_id

Any of:

string

string

null

null

send_in_same_thread

Any of:

boolean

boolean

null

null

textual_agent_name

Any of:

string

string

null

null

voice_agent_name

Any of:

string

string

null

null

wait_for_new_contacts

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

object

data

required

One nurture sequence.

object

created_at

Any of:

string

string format: date-time

null

null

id

Any of:

string

string

null

null

is_shared

Any of:

boolean

boolean

null

null

name

Any of:

string

string

null

null

status

Any of:

string

string

null

null

updated_at

Any of:

string

string format: date-time

null

null

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string