Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"status": "active",
"brandId": "BRAND123",
"campaignId": "CAMP456",
"providerStatus": "ACTIVE",
"updatedAt": "2026-07-13T11:00:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}SMS
Reconcile the registration status from the carrier (non-billable)
Pulls the brand/campaign status directly from the provider and updates the local status. Used as a manual “refresh” when a status webhook is delayed; surfaces a failed campaign’s rejection reasons. Does not charge.
POST
/
sms
/
refresh
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"status": "active",
"brandId": "BRAND123",
"campaignId": "CAMP456",
"providerStatus": "ACTIVE",
"updatedAt": "2026-07-13T11:00:00.000Z"
}
}{
"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:read
Read the org's SMS (10DLC) registration status and numbers, SMS contacts, and download any text-message attachment by id (getSMSMedia) — pictures, videos and files (such as a PDF) sent or received by text.