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 Shared Campaigns API

The Shared Campaigns API from Telnyx — 4 operation(s) for shared campaigns.

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

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

This API exposes 5 operations across 4 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.

5 operations 4 paths 10 schemas 4 GET1 PATCH

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 Shared Campaigns 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 5

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

Shared Campaigns 5
GET
/10dlc/partnerCampaign/sharedByMe
List shared partner campaigns
GetPartnerCampaignsSharedByUser 2 params → 2004224XX
GET
/10dlc/partnerCampaign/{campaignId}/sharing
Get Sharing Status
GetPartnerCampaignSharingStatus 1 param → 2004224XX
GET
/10dlc/partner_campaigns
List Shared Campaigns
GetSharedCampaigns 3 params → 2004224XX
GET
/10dlc/partner_campaigns/{campaignId}
Get Single Shared Campaign
GetSharedCampaign 1 param → 2004224XX
PATCH
/10dlc/partner_campaigns/{campaignId}
Update Single Shared Campaign
UpdateSharedCampaign 1 param body → 2004224XX

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are TelnyxDownstreamCampaign (37 properties), SharedCampaign (5 properties), CampaignSharingStatus (5 properties), 10dlc_Error (4 properties). Each schema is shown below with its type and property counts.

TelnyxDownstreamCampaign
object
Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. On…
37 properties 2 required
SharedCampaignRecordSet
object
3 properties
10dlc_Error
object
4 properties 2 required
10dlc_Errors
object
1 property
ValidationError
object
3 properties 3 required
CampaignSharingStatus
object
5 properties
TelnyxDownstreamCampaignRecordSet
object
3 properties
SharedCampaign
object
Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - campaignId. On…
5 properties 3 required
HTTPValidationError
object
1 property
UpdatePartnerCampaignRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-shared-campaigns-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