Telnyx Shared Campaigns API

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

GitHub OpenAPI
Business capability
SMS & Messaging Apps AE-150.20

Operations 5

GET /10dlc/partnerCampaign/sharedByMe List shared partner campaigns #
GET /10dlc/partnerCampaign/{campaignId}/sharing Get Sharing Status #
GET /10dlc/partner_campaigns List Shared Campaigns #
GET /10dlc/partner_campaigns/{campaignId} Get Single Shared Campaign #
PATCH /10dlc/partner_campaigns/{campaignId} Update Single Shared Campaign #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx:telnyx-shared-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-shared-campaigns-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Telnyx Shared Campaigns API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Shared Campaigns across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Shared Campaigns
paths:
  /10dlc/partnerCampaign/sharedByMe:
    get:
      tags:
      - Shared Campaigns
      summary: List shared partner campaigns
      description: 'Get all partner campaigns you have shared to Telnyx in a paginated fashion


        This endpoint is currently limited to only returning shared campaigns that Telnyx

        has accepted. In other words, shared but pending campaigns are currently omitted

        from the response from this endpoint.'
      operationId: GetPartnerCampaignsSharedByUser
      parameters:
      - description: The 1-indexed page number to get. The default value is `1`.
        required: false
        schema:
          title: Page
          type: integer
          description: The 1-indexed page number to get. The default value is `1`.
          default: 1
        name: page
        in: query
      - description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
        required: false
        schema:
          title: Recordsperpage
          type: integer
          description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
          default: 10
        name: recordsPerPage
        in: query
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedCampaignRecordSet'
              example:
                page: 0
                records:
                - brandId: Brandid
                  campaignId: Campaignid
                  createDate: Createdate
                  status: Status
                  usecase: Usecase
                totalRecords: 0
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/10dlc_HTTPValidationError'
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /10dlc/partnerCampaign/{campaignId}/sharing:
    get:
      tags:
      - Shared Campaigns
      summary: Get Sharing Status
      operationId: GetPartnerCampaignSharingStatus
      parameters:
      - description: ID of the campaign in question
        required: true
        schema:
          title: Campaignid
          type: string
          description: ID of the campaign in question
        name: campaignId
        in: path
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                title: Response Get Sharing Status Public Partnercampaign  Campaignid  Sharing Get
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/CampaignSharingStatus'
              example: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/10dlc_HTTPValidationError'
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
      description: Returns the partner-sharing state for the specified campaign.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /10dlc/partner_campaigns:
    get:
      tags:
      - Shared Campaigns
      summary: List Shared Campaigns
      operationId: GetSharedCampaigns
      parameters:
      - description: The 1-indexed page number to get. The default value is `1`.
        required: false
        schema:
          title: Page
          type: integer
          description: The 1-indexed page number to get. The default value is `1`.
          default: 1
        name: page
        in: query
      - description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
        required: false
        schema:
          title: Recordsperpage
          type: integer
          description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.
          default: 10
        name: recordsPerPage
        in: query
      - name: sort
        required: false
        schema:
          title: Sort
          description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          type: string
          enum:
          - assignedPhoneNumbersCount
          - -assignedPhoneNumbersCount
          - brandDisplayName
          - -brandDisplayName
          - tcrBrandId
          - -tcrBrandId
          - tcrCampaignId
          - -tcrCampaignId
          - createdAt
          - -createdAt
          - campaignStatus
          - -campaignStatus
          default: -createdAt
        in: query
        description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order.
        example: -assignedPhoneNumbersCount
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelnyxDownstreamCampaignRecordSet'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/10dlc_HTTPValidationError'
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
      description: 'Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion.


        This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /10dlc/partner_campaigns/{campaignId}:
    get:
      tags:
      - Shared Campaigns
      summary: Get Single Shared Campaign
      operationId: GetSharedCampaign
      parameters:
      - required: true
        schema:
          title: Campaignid
          type: string
        name: campaignId
        in: path
        description: Unique identifier of the campaign.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelnyxDownstreamCampaign'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/10dlc_HTTPValidationError'
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
      description: Retrieve campaign details by `campaignId`.
    patch:
      tags:
      - Shared Campaigns
      summary: Update Single Shared Campaign
      operationId: UpdateSharedCampaign
      parameters:
      - required: true
        schema:
          title: Campaignid
          type: string
        name: campaignId
        in: path
        description: Unique identifier of the campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePartnerCampaignRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TelnyxDownstreamCampaign'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/10dlc_HTTPValidationError'
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
      description: Update campaign details by `campaignId`. **Please note:** Only webhook urls are editable.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    10dlc_HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      properties:
        loc:
          title: Location
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
    UpdatePartnerCampaignRequest:
      title: UpdateCampaignRequest
      type: object
      properties:
        webhookURL:
          title: WebhookURL
          type: string
          description: Webhook to which campaign status updates are sent.
          example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93
        webhookFailoverURL:
          title: WebhookURL
          type: string
          description: Webhook failover to which campaign status updates are sent.
          example: https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6
    SharedCampaignRecordSet:
      title: SharedCampaignRecordSet
      type: object
      properties:
        page:
          title: Page
          type: integer
        records:
          title: Records
          type: array
          items:
            $ref: '#/components/schemas/SharedCampaign'
        totalRecords:
          title: Totalrecords
          type: integer
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    TelnyxDownstreamCampaignRecordSet:
      title: TelnyxDownstreamCampaignRecordSet
      type: object
      properties:
        records:
          title: Records
          type: array
          items:
            $ref: '#/components/schemas/TelnyxDownstreamCampaign'
        page:
          title: Page
          type: integer
        totalRecords:
          title: Totalrecords
          type: integer
    TelnyxDownstreamCampaign:
      title: TelnyxDownstreamCampaign
      required:
      - tcrBrandId
      - tcrCampaignId
      type: object
      properties:
        ageGated:
          title: AgeGated
          type: boolean
          description: Age gated content in campaign.
        assignedPhoneNumbersCount:
          title: AssignedPhoneNumbersCount
          description: Number of phone numbers associated with the campaign
          type: number
          example: 3
        brandDisplayName:
          title: Branddisplayname
          description: Display or marketing name of the brand.
          example: ABC Mobile
          type: string
        campaignStatus:
          title: campaignStatus
          description: Campaign status
          example: TCR_ACCEPTED
          enum:
          - TCR_PENDING
          - TCR_SUSPENDED
          - TCR_EXPIRED
          - TCR_ACCEPTED
          - TCR_FAILED
          - TELNYX_ACCEPTED
          - TELNYX_FAILED
          - MNO_PENDING
          - MNO_ACCEPTED
          - MNO_REJECTED
          - MNO_PROVISIONED
          - MNO_PROVISIONING_FAILED
          type: string
        description:
          title: Description
          type: string
          description: Summary description of this campaign.
        directLending:
          title: Directlending
          type: boolean
          description: Direct lending or loan arrangement.
        embeddedLink:
          title: Embeddedlink
          type: boolean
          description: Does message generated by the campaign include URL link in SMS?
        embeddedLinkSample:
          title: EmbeddedLinkSample
          type: string
          description: Sample of an embedded link that will be sent to subscribers.
        embeddedPhone:
          title: Embeddedphone
          type: boolean
          description: Does message generated by the campaign include phone number in SMS?
        failureReasons:
          title: failureReasons
          description: Failure reasons if campaign submission failed
          type: string
        helpKeywords:
          title: Helpkeywords
          type: string
          description: Subscriber help keywords. Multiple keywords are comma separated without space.
        helpMessage:
          title: Helpmessage
          type: string
          description: Help message of the campaign.
        isNumberPoolingEnabled:
          title: isNumberPoolingEnabled
          type: boolean
          description: Indicates whether the campaign has a T-Mobile number pool ID associated with it.
        messageFlow:
          title: Messageflow
          type: string
          description: Message flow description.
        numberPool:
          title: Numberpool
          type: boolean
          description: Does campaign utilize pool of phone numbers?
        optinKeywords:
          title: Optinkeywords
          type: string
          description: Subscriber opt-in keywords. Multiple keywords are comma separated without space.
        optinMessage:
          title: Optinmessage
          type: string
          description: Subscriber opt-in message.
        optoutKeywords:
          title: Optoutkeywords
          type: string
          description: Subscriber opt-out keywords. Multiple keywords are comma separated without space.
        optoutMessage:
          title: Optoutmessage
          type: string
          description: Subscriber opt-out message.
        privacyPolicyLink:
          title: PrivacyPolicyLink
          type: string
          description: Link to the campaign's privacy policy.
        usecase:
          title: Usecase
          type: string
          description: Campaign usecase. Must be of defined valid types. Use `/10dlc/enum/usecase` operation to retrieve usecases available for given brand.
        sample1:
          title: Sample1
          type: string
          description: Message sample. Some campaign tiers require 1 or more message samples.
        sample2:
          title: Sample2
          type: string
          description: Message sample. Some campaign tiers require 2 or more message samples.
        sample3:
          title: Sample3
          type: string
          description: Message sample. Some campaign tiers require 3 or more message samples.
        sample4:
          title: Sample4
          type: string
          description: Message sample. Some campaign tiers require 4 or more message samples.
        sample5:
          title: Sample5
          type: string
          description: Message sample. Some campaign tiers require 5 or more message samples.
        subUsecases:
          title: Subusecases
          uniqueItems: true
          type: array
          items:
            type: string
          description: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/10dlc/enum/usecase` operation to retrieve list of valid sub-usecases
        subscriberOptin:
          title: Subscriberoptin
          type: boolean
          description: Does campaign require subscriber to opt-in before SMS is sent to subscriber?
        subscriberOptout:
          title: Subscriberoptout
          type: boolean
          description: Does campaign support subscriber opt-out keyword(s)?
        tcrBrandId:
          title: TcrBrandid
          type: string
          description: Unique identifier assigned to the brand by the registry.
          example: BBRAND1
        tcrCampaignId:
          title: TcrCampaignid
          type: string
          description: Unique identifier assigned to the campaign by the registry.
          example: CCAMP1
        termsAndConditions:
          title: Termsandconditions
          type: boolean
          description: Is terms & conditions accepted?
        termsAndConditionsLink:
          title: TermsAndConditionsLink
          type: string
          description: Link to the campaign's terms and conditions.
        webhookURL:
          title: WebhookURL
          type: string
          description: Webhook to which campaign status updates are sent.
          example: https://example.com/webhook
        webhookFailoverURL:
          title: WebhookFailoverURL
          type: string
          description: Failover webhook to which campaign status updates are sent.
          example: https://example.com/failover-webhook
        createdAt:
          type: string
          description: Date and time that the brand was created at.
          example: '2021-03-08T17:57:48.801186'
        updatedAt:
          type: string
          description: Date and time that the brand was last updated at.
          example: '2021-03-08T17:57:48.801186'
      description: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service.
    SharedCampaign:
      title: SharedCampaign
      required:
      - brandId
      - campaignId
      - usecase
      type: object
      properties:
        brandId:
          title: Brandid
          type: string
          description: Alphanumeric identifier of the brand associated with this campaign.
        campaignId:
          title: Campaignid
          type: string
          description: Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.
        createDate:
          title: Createdate
          type: string
          description: Unix timestamp when campaign was created.
        status:
          title: Status
          type: string
          description: 'Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. '
        usecase:
          title: Usecase
          type: string
          description: Campaign usecase. Must be of defined valid types. Use `/10dlc/enum/usecase` operation to retrieve usecases available for given brand.
      description: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**.
    CampaignSharingStatus:
      title: CampaignSharingStatus
      type: object
      properties:
        downstreamCnpId:
          title: Downstreamcnpid
          type: string
        sharedDate:
          title: Shareddate
          type: string
        sharingStatus:
          title: Sharingstatus
          type: string
        statusDate:
          title: Statusdate
          type: string
        upstreamCnpId:
          title: Upstreamcnpid
          type: string
    10dlc_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/10dlc_Error'
          type: array
      type: object
    10dlc_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  responses:
    10dlc_GenericErrorResponse_ca4eb0ad6f:
      description: Generic response error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: string
              title: string
              detail: string
              source:
                pointer: string
                parameter: string
    10dlc_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/10dlc_Errors'
      description: Generic response error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt