Skip to content

Give the conversation back to the AI agent

POST
/leads/{id}/resume
curl --request POST \
--url https://app.whatsetter.com/api/v1/leads/example/resume \
--header 'Authorization: Bearer <token>'

The mirror of /handoff: the AI agent takes the conversation back and resumes replying to this lead. Equivalent to “réactiver l’IA” in the dashboard.

Like /handoff, the business status is preserved and the call is idempotent. Requires scope leads:write.

id
required
string

The WhatSetter lead id (same as contact.id on webhooks).

The agent is active again on this conversation

Media typeapplication/json
object
data

Who is driving a conversation after a handoff/resume call.

object
id

The lead id.

string
external_reference

Your own id, echoed so you can log the action against your record.

string | null
agent_active

false after /handoff, true after /resume.

boolean
manual_override

true when a human holds the conversation.

boolean
status

The lead’s business status — unchanged by these calls.

string | null
dashboard_synced

Whether the leads-list mirror was updated too. false means the agent is correctly stopped but the dashboard list may lag; the conversation view is always right.

boolean
updated_at
string format: date-time
Examplegenerated
{
"data": {
"id": "example",
"external_reference": "example",
"agent_active": true,
"manual_override": true,
"status": "example",
"dashboard_synced": true,
"updated_at": "2026-04-15T12:00:00Z"
}
}

Missing, unknown or revoked API key

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Resource not found in this workspace

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

invalid_state: the lead has no conversation yet (not contacted).

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

Agent control is not configured on this deployment (internal_error)

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}

upstream_error: the agent-control workflow was unreachable or refused the change. Safe to retry.

Media typeapplication/json
object
error
object
code
string
message
string
Examplegenerated
{
"error": {
"code": "example",
"message": "example"
}
}