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 Profiles API

Messaging profiles

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

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 12 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.

7 operations 4 paths 12 schemas 1 DELETE4 GET1 PATCH1 POST

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 Profiles 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 7

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

Profiles 7

Messaging profiles

GET
/messaging_profiles
List messaging profiles
ListMessagingProfiles 4 params → 2004XX
POST
/messaging_profiles
Create a messaging profile
CreateMessagingProfile body → 2004XX
DELETE
/messaging_profiles/{id}
Delete a messaging profile
DeleteMessagingProfile 1 param → 2004XX
GET
/messaging_profiles/{id}
Retrieve a messaging profile
RetrieveMessagingProfile 1 param → 2004XX
PATCH
/messaging_profiles/{id}
Update a messaging profile
UpdateMessagingProfile 1 param body → 2004XX
GET
/messaging_profiles/{id}/phone_numbers
List phone numbers associated with a messaging profile
ListProfilePhoneNumbers 2 params → 2004XX
GET
/messaging_profiles/{id}/short_codes
List short codes associated with a messaging profile
ListProfileShortCodes 2 params → 2004XX

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are MessagingProfile (26 properties), UpdateMessagingProfileRequest (20 properties), CreateMessagingProfileRequest (18 properties), PhoneNumberWithMessagingSettings (15 properties). Each schema is shown below with its type and property counts.

MessagingFeatureSet
objectnull
The set of features available for a specific messaging use case (SMS or MMS). Features can vary depending on the characteristics the phone number, as well as i…
3 properties 3 required
NumberPoolSettings
objectnull
Number Pool allows you to send messages from a pool of numbers of different types, assigning weights to each type. The pool consists of all the long code and t…
5 properties 3 required
MessagingProfile
object
26 properties
UpdateMessagingProfileRequest
object
20 properties
CreateMessagingProfileRequest
object
18 properties 2 required
UrlShortenerSettings
objectnull
The URL shortener feature allows automatic replacement of URLs that were generated using a public URL shortener service. Some examples include bit.do, bit.ly,…
4 properties 1 required
ShortCode
object
8 properties 1 required
messaging_Errors
object
1 property
messaging_PaginationMeta
object
4 properties 4 required
messaging_Error
object
5 properties 2 required
PhoneNumberWithMessagingSettings
object
15 properties
NumberHealthMetrics
object
High level health metrics about the number and it's messaging sending patterns.
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-profiles-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