Update a TFN profile

patch

https://app.ekas.io/v1/tfn-profiles/{id}

Partial update. Changing the use case, opt-in, or volume tier on a verified profile requires re-verification via POST /registrations/{id}/reverify — the prior approval stays active until the new decision lands. Returns 409 while a registration referencing this profile is in flight.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Partial update. Changing use case, opt-in, or volume tier on a verified profile requires re-verification (POST /registrations/{id}/reverify).

use_case

string

use_case_summary

string

sample_messages

array of strings

sample_messages

monthly_volume

string

enum

Expected messages per month across the profile's numbers.

opt_in

object

business_contact

object

on_behalf_of

object

additional_information

string

privacy_policy_url

uri

terms_url

uri

metadata

object

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

Headers

If-Match

string

ETag from a previous read; the write fails with 412 if the resource changed.

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200The updated TFN profile.

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.

404No such resource (or it belongs to another mode/subaccount).

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

412If-Match ETag no longer matches the resource.

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