Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"e164": "+14155550100",
"smsStatus": "pending",
"agentName": "Front Desk",
"agentId": "agt_4f9c2b7e10a24d51"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}SMS
Enable or disable an owned number for SMS (assign to the campaign)
Turn texting on or off for one owned number by adding it to (or removing it from) the org’s 10DLC campaign. After enabling, the number’s smsStatus goes pending while the carriers add it (up to ~1h) and then flips to active — it can’t send reliably until active. Requires an active org registration first (see submitSMSRegistration).
PATCH
/
sms
/
numbers
/
{e164}
Error
A valid request URL is required to generate request examples{
"success": true,
"data": [
{
"e164": "+14155550100",
"smsStatus": "pending",
"agentName": "Front Desk",
"agentId": "agt_4f9c2b7e10a24d51"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
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
The number in E.164 format.
Body
application/json