Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

FlowClient Credentials
Token URL
/api/v1/api-keys
Scopes1
sms:write
Save/submit the 10DLC registration, toggle numbers for SMS, record or revoke a contact's SMS consent, and upload pictures and short videos to send by text.

Path Parameters

e164
string
required

The contact's number in E.164 format (e.g. +14155551234).

Body

application/json

Optional context for pausing the AI for one contact. The body may be omitted.

note
string

Why the AI is paused or who is handling the conversation (at most 500 characters, whitespace-trimmed). Shown on getSMSContact and on the conversation's "AI paused" marker in Observe. An empty or omitted note keeps the one already stored.

Maximum string length: 500
Example:

"handled by Kiwi ops (ticket 8812)"

Response

The AI is paused for the contact (also 200, with the original pausedAt, when it already was).

success
boolean
required
data
object
required

The result of pausing the AI for one contact.

message
string
errors
object[]