Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "legalName": "Peak Comfort HVAC LLC",
    "displayName": "Peak Comfort HVAC",
    "status": "submitted",
    "brandId": "BRAND123",
    "campaignId": "CAMP456",
    "submittedAt": "2026-07-13T10:55: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>"
    }
  ]
}

{
  "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

Submit the 10DLC registration (billable — debits the activation fee)

Re-runs the full compliance review and refuses unless GREEN, then debits the SMS activation (2,500 credits / $25) and registers the brand + campaign with the carrier registry. Status then updates asynchronously via the provider webhook. Activating SMS also starts a recurring 10DLC MANAGEMENT fee of 500 credits ($ 5) per month while the registration stays active — the first month is included in the activation charge, so the first monthly fee is debited 30 days after activation.

POST

sms

submit

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "legalName": "Peak Comfort HVAC LLC",
    "displayName": "Peak Comfort HVAC",
    "status": "submitted",
    "brandId": "BRAND123",
    "campaignId": "CAMP456",
    "submittedAt": "2026-07-13T10:55: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>"
    }
  ]
}

{
  "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

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.

Response

Submitted; registration now pending carrier review.

success

boolean

required

data

object

required

The org's 10DLC brand+campaign registration (draft + provider status).

Show child attributes

message

string

errors

object[]

Show child attributes

Using the API

Endpoints

Submit the 10DLC registration (billable — debits the activation fee)

Authorizations

Response