Shared Campaigns

Shared Campaigns API

Get Partner Campaigns Shared By User

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.

SecuritybearerAuth
Request
query Parameters
page
integer (Page)
Default: 1

The 1-indexed page number to get. The default value is 1.

recordsPerPage
integer (Recordsperpage)
Default: 10

The amount of records per page, limited to between 1 and 500 inclusive. The default value is 10.

Responses
200

Successful Response

Response Schema: application/json
page
integer (Page)
Array of objects (Records)
totalRecords
integer (Totalrecords)
422

Validation Error

Response Schema: application/json
Array of objects (Detail)
Array
required
Array of strings or integers (Location)
msg
required
string (Message)
type
required
string (Error Type)
get/partnerCampaign/sharedByMe
Request samples 
Response samples 
application/json
{
  • "page": 0,
  • "records": [
    • {
      • "brandId": "string",
      • "campaignId": "string",
      • "createDate": "string",
      • "status": "string",
      • "usecase": "string"
      }
    ],
  • "totalRecords": 0
}
Get Sharing Status
SecuritybearerAuth 
Request 
path Parameters
campaignId
required
string (Campaignid) 
ID of the campaign in question


 
Responses 
200
Successful Response


Response Schema: application/json
additional property
object (CampaignSharingStatus) 
 
downstreamCnpId
string (Downstreamcnpid) 
 
sharedDate
string (Shareddate) 
 
sharingStatus
string (Sharingstatus) 
 
statusDate
string (Statusdate) 
 
upstreamCnpId
string (Upstreamcnpid) 
 
422
Validation Error


Response Schema: application/json
Array of objects (Detail) 
 
 Array 
required
Array of strings or integers (Location) 
 
msg
required
string (Message) 
 
type
required
string (Error Type) 
 
get/partnerCampaign/{campaignId}/sharing
Request samples 
Response samples 
application/json
{
  • "property1": {
    • "downstreamCnpId": "string",
    • "sharedDate": "string",
    • "sharingStatus": "string",
    • "statusDate": "string",
    • "upstreamCnpId": "string"
    },
  • "property2": {
    • "downstreamCnpId": "string",
    • "sharedDate": "string",
    • "sharingStatus": "string",
    • "statusDate": "string",
    • "upstreamCnpId": "string"
    }
}