AI Agent

Turn a single agent assignment on or off

Stops (or resumes) the agent answering on one assigned number or call flow, without unassigning it.

What changes depends on the assignment's context: an ai_ivr assignment flips use_ai_ivr on the number or call flow, while a forward assignment closes the agent's leg inside the routing so calls walk straight past it. Resuming a forward restores 24/7 — the previous window is not kept.

patch/companies/{company}/agents/{agent}/assignments/{assignment}

Path parameters

companyinteger required

agentinteger required

Agent ID

assignmentinteger required

Assignment ID

Request body

activeboolean required

Response

Updated assignment

idinteger

isActiveboolean

Whether the agent currently answers here. False means the assignment is kept but paused — AI IVR switched off, or the agent's leg closed inside the routing.

answerTriggersstring[] nullable

When the AI receptionist answers on this assignment. Empty/null means every call. Always null for forward-context assignments.

createdBystring nullable

createdAtstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.