Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"registration": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"status": "active",
"useCase": "customer_care",
"brandId": "BRAND123",
"campaignId": "CAMP456"
},
"numbers": [
{
"e164": "+14155550100",
"smsStatus": "active",
"agentName": "Front Desk",
"agentId": "agt_4f9c2b7e10a24d51"
}
],
"policyPageUrl": "https://flowyte.com/p/org_2a1b9c/sms-policy",
"priceCredits": 2500,
"monthlyFeeCredits": 500
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}SMS
Get the org's SMS (10DLC) registration, numbers, and status
Read the SMS Hub state in one call: the org’s 10DLC registration (draft fields + carrier status), each owned number’s SMS-enablement state, the policy-page URL, and the activation + monthly fees. This is the surface a client renders the whole SMS setup from.
GET
/
sms
Error
A valid request URL is required to generate request examples{
"success": true,
"data": {
"registration": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"status": "active",
"useCase": "customer_care",
"brandId": "BRAND123",
"campaignId": "CAMP456"
},
"numbers": [
{
"e164": "+14155550100",
"smsStatus": "active",
"agentName": "Front Desk",
"agentId": "agt_4f9c2b7e10a24d51"
}
],
"policyPageUrl": "https://flowyte.com/p/org_2a1b9c/sms-policy",
"priceCredits": 2500,
"monthlyFeeCredits": 500
}
}{
"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.