Skip to main content
PATCH
Rewrite a follow-up on a pending email card

Authorizations

X-API-Key
string
header
required

Path Parameters

task_id
string<uuid>
required
step_id
string<uuid>
required

Body

application/json

Rewrite one follow-up on a pending email card.

subject left out keeps the follow-up's own subject; a follow-up that replies in the thread above it has none, and any given to it is ignored.

body
string
required
Required string length: 1 - 50000
message_id
string<uuid> | null

The follow-up's message_id as the card read it: an edit over a follow-up written again since is refused with 409.

subject
string | null

A new subject for a follow-up that has its own; leave it out to keep it.

Maximum string length: 255

Response

Successful Response

One follow-up the agent drafted with the card's email: approving the card approves it.

The follow-ups after the card's own email, in the order they go. One approval covers them all: approving the card approves each to send as written when its turn comes, with no card of its own, and rejecting the card stops the contact.

body
string
required

What it will send, as drafted or as a person edited it.

label
string
required

The step's number and name, as the Preview says it: Step 2 · New angle.

message_id
string<uuid>
required

The agent's message holding its words; a new one when it is written again.

step_id
string<uuid>
required

The follow-up's step.

subject
string | null
required

Its own subject, or null when it replies in the thread above it.

wait_amount
integer
required

How long after the email before it the step waits.

wait_unit
string
required

The unit of that wait: minutes, hours or days.