Skip to content
DashboardGet API key

Assign phone number to campaign

View .md
POST

Assign a US phone number to an approved 10DLC campaign. The campaign must be in approved status.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • campaignIdstringrequired

    10DLC campaign ID.

Body

application/json

  • phoneNumberIdstringrequired

    ID of the phone number to assign.

Responses

201Phone number assigned.
  • assignmentobjectrequired
    8 properties
    • idstringrequired
    • campaignIdstringrequired
    • phoneNumberIdstringrequired
    • statusstringrequired

      Assignment status. pending: sent to the carrier, not confirmed yet. active: the number is on the campaign and can send. failed: the carrier refused it; see failureReason. The number is free to be assigned again.

      One ofpendingactivefailed
    • failureReasonstringnullable
    • assignedAtstring<date-time>nullable
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
400Campaign not approved or invalid request.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Campaign or phone number not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject