Create a TFN profile

post

https://app.ekas.io/v1/tfn-profiles

Create a toll-free verification profile under a brand. Toll-free numbers are a sub-resource because verification decisions are made per number; the optional phone_numbers array on create is a convenience for initial attachment.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create a stored TFN profile.

brand_id

string

required

use_case

string

required

use_case_summary

string

required

sample_messages

array of strings

sample_messages

monthly_volume

string

enum

required

Expected messages per month across the profile's numbers.

opt_in

object

required

business_contact

object

on_behalf_of

object

additional_information

string

privacy_policy_url

uri

terms_url

uri

phone_numbers

array of strings

Convenience — initial toll-free numbers (also manageable via the sub-resource).

phone_numbers

metadata

object

Free-form string map (≤50 keys, values ≤500 chars). Filterable on list endpoints.

Headers

Idempotency-Key

string

length ≤ 255

Any unique string (e.g. a UUID). Retries with the same key within 24h return the original response with Idempotent-Replayed: true. Same key + different body → 409.

Ekas-Subaccount

string

Scope this request (and the created resource) to a subaccount.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201TFN profile created.

400Invalid request (malformed body, missing/invalid parameter).

401Missing or invalid API key.

403API key lacks a required scope (named in error.param) or test-only endpoint called with a live key.

409Invalid state transition, in-flight registration conflict, or idempotency key reuse with a different body.

429Rate limit exceeded; see Retry-After. RateLimit-* headers appear on every response, not only 429s.