Sign in
Bulk Phone Number Campaigns

Assign Messaging Profile To Campaign

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.

post/10dlc/phoneNumberAssignmentByProfile

Request body

campaignIdstring

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.

messagingProfileIdstring required

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

tcrCampaignIdstring

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.

Example request

{
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j",
  "messagingProfileId": "4001767e-ce0f-4cae-9d5f-0d5e636e7809",
  "tcrCampaignId": "CWZTFH1"
}

Response

Successful Response

campaignIdstring

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.

messagingProfileIdstring required

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

taskIdstring required

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

tcrCampaignIdstring

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.

Example response

{
  "campaignId": "4b300178-131c-d902-d54e-72d90ba1620j",
  "messagingProfileId": "4001767e-ce0f-4cae-9d5f-0d5e636e7809",
  "taskId": "667a80f8-b0a9-49d0-b9ab-a7a1bcc45086",
  "tcrCampaignId": "CWZTFH1"
}

Changes

Changed in 2 of the 61 revisions of this API.211

  • 1571b0380bd711See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta from the response with the 4XX status

      response-optional-property-removed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e53799411See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ○

      added the optional property errors/items/meta to the response with the 4XX status

      response-optional-property-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog