Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Opt-Out Management API

Opt-Out Management

Telnyx Opt-Out Management API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Opt-Out Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

6 operations 3 paths 10 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Opt-Out Management API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Opt-Out Management 6

Opt-Out Management

GET
/messaging_optouts
List opt-outs
ListOptOuts 4 params → 200400401
GET
/messaging_profiles/{profile_id}/autoresp_configs
List Auto-Response Settings
GetAutorespConfigs 4 params → 2004XX
POST
/messaging_profiles/{profile_id}/autoresp_configs
Create auto-response setting
CreateAutorespConfig 1 param body → 2004XX
DELETE
/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Delete Auto-Response Setting
DeleteAutorespConfig 2 params → 2004XX
GET
/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Get Auto-Response Setting
GetAutorespConfig 2 params → 2004XX
PUT
/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Update Auto-Response Setting
UpdateAutoRespConfig 2 params body → 2004XX

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AutorespConfigSchema (7 properties), messaging_Error (5 properties), OptOutItem (5 properties), AutoRespConfigCreateSchema (4 properties). Each schema is shown below with its type and property counts.

AutorespConfigSchema
object
7 properties 6 required
OptOutListResponse
object
2 properties
messaging_Errors
object
1 property
AutorespConfigResponseSchema
object
1 property 1 required
messaging_PaginationMeta
object
4 properties 4 required
AutorespConfigsResponseSchema
object
List of Auto-Response Settings
2 properties 2 required
AutoRespConfigCreateSchema
object
4 properties 3 required
ToNumber
string
Receiving address (+E.164 formatted phone number or short code).
messaging_Error
object
5 properties 2 required
OptOutItem
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-opt-out-management-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API