A valid request URL is required to generate request examples{
"success": true,
"data": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"vertical": "hvac",
"useCase": "customer_care",
"status": "draft",
"sample1": "Peak Comfort HVAC: your technician is on the way. Reply STOP to opt out.",
"sample2": "Peak Comfort HVAC: your appointment is confirmed for Tue 9am. Reply HELP for help.",
"updatedAt": "2026-07-13T10:50:00.000Z"
}
}{
"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>"
}
]
}Save the 10DLC registration draft (auto-generates compliant campaign text)
Save (upsert) the org’s 10DLC registration draft — brand details, use case, and opt-in info — and have Flowyte auto-generate compliant campaign text and sample messages from it. This does NOT submit to the carrier or charge; it just persists the draft. Run reviewSMSRegistration next to get a compliance verdict, then submitSMSRegistration to go live.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"legalName": "Peak Comfort HVAC LLC",
"displayName": "Peak Comfort HVAC",
"vertical": "hvac",
"useCase": "customer_care",
"status": "draft",
"sample1": "Peak Comfort HVAC: your technician is on the way. Reply STOP to opt out.",
"sample2": "Peak Comfort HVAC: your appointment is confirmed for Tue 9am. Reply HELP for help.",
"updatedAt": "2026-07-13T10:50:00.000Z"
}
}{
"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.
- Token URL
- /api/v1/api-keys
Body
Writable fields of a 10DLC registration draft.
Regenerate the compliant campaign text from brand + use case.
Optional quiet-hours posture knob. Omit to leave the stored posture unchanged; true = replies skip quiet hours (default), false = strict (replies also held to the window).