Assign Messaging Profile To Campaign

POST 
/phoneNumberAssignmentByProfile

This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. Please note: if you want to assign phone numbers to a campaign that you did not create with Telnyx 10DLC services, this endpoint allows that provided that you've shared the campaign with Telnyx. In this case, only provide the parameter, tcrCampaignId, and not campaignId. In all other cases (where the campaign you're assigning was created with Telnyx 10DLC services), only provide campaignId, not tcrCampaignId.

Request

application/json

Body

required

messagingProfileId Messagingprofileid (string)required

The ID of the messaging profile that you want to link to the specified campaign.

tcrCampaignId Tcrcampaignid (string)

The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId.

campaignId Campaignid (string)

The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId.

Responses

202: Successful Response

application/json

• Schema
• Example (from schema)

Schema

anyOf

• AssignProfileToCampaignResponse
• SettingsDataErrorMessage

messagingProfileId Messagingprofileid (string)required

The ID of the messaging profile that you want to link to the specified campaign.

tcrCampaignId Tcrcampaignid (string)

The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId.

campaignId Campaignid (string)

The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId.

taskId Taskid (string)required

The ID of the task associated with assigning a messaging profile to a campaign.

message Message (string)required

{}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      }
    }
  ]
}

Loading...