Update an existing 10DLC campaign registration. Campaign fields are editable before carrier submission; workflow status is managed by Pingram.

PATCH

/registrations/us/10dlc/campaign

curl --request PATCH \
  --url https://api.pingram.io/registrations/us/10dlc/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "campaignDescription": "example", "campaignSample1": "example", "campaignSample2": "example", "campaignSample3": "example", "campaignSample4": "example", "campaignMessageFlow": "example", "campaignOptinKeywords": "example", "campaignOptinMessage": "example", "campaignOptoutKeywords": "example", "campaignOptoutMessage": "example", "campaignHelpKeywords": "example", "campaignHelpMessage": "example", "campaignEmbeddedLink": true, "campaignEmbeddedLinkUrl": "example", "campaignEmbeddedPhone": true, "campaignAgeGated": true, "campaignDirectLending": true, "campaignPrivacyPolicyLink": "example", "campaignTermsAndConditionsLink": "example", "campaignUsecase": "example" }'

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

Request Body^required

Media typeapplication/json

Request body for PATCH /registrations/us/10dlc/campaign

object

campaignDescription

string

campaignSample1

string

campaignSample2

string

campaignSample3

string

campaignSample4

string

campaignMessageFlow

string

campaignOptinKeywords

string

campaignOptinMessage

string

campaignOptoutKeywords

string

campaignOptoutMessage

string

campaignHelpKeywords

string

campaignHelpMessage

string

campaignEmbeddedLink

boolean

campaignEmbeddedLinkUrl

string

campaignEmbeddedPhone

boolean

campaignAgeGated

boolean

campaignDirectLending

boolean

campaignPrivacyPolicyLink

string

campaignTermsAndConditionsLink

string

campaignUsecase

string

Example^generated

{
  "campaignDescription": "example",
  "campaignSample1": "example",
  "campaignSample2": "example",
  "campaignSample3": "example",
  "campaignSample4": "example",
  "campaignMessageFlow": "example",
  "campaignOptinKeywords": "example",
  "campaignOptinMessage": "example",
  "campaignOptoutKeywords": "example",
  "campaignOptoutMessage": "example",
  "campaignHelpKeywords": "example",
  "campaignHelpMessage": "example",
  "campaignEmbeddedLink": true,
  "campaignEmbeddedLinkUrl": "example",
  "campaignEmbeddedPhone": true,
  "campaignAgeGated": true,
  "campaignDirectLending": true,
  "campaignPrivacyPolicyLink": "example",
  "campaignTermsAndConditionsLink": "example",
  "campaignUsecase": "example"
}

Responses

200

Successful response

Media typeapplication/json

Public response type for 10DLC campaign registration

object

accountId

required

string

campaignStatus

required

Pingram-side 10DLC registration workflow status (brand or campaign).

• not_started: no customer submission yet
• pending_review: customer submitted; Pingram has not submitted to carriers
• in_progress: submitted for carrier review
• approved | rejected | info_needed: review outcome

string

Allowed values: not_started in_progress pending_review approved rejected info_needed

campaignDescription

string

campaignSample1

string

campaignSample2

string

campaignSample3

string

campaignSample4

string

campaignMessageFlow

string

campaignOptinKeywords

string

campaignOptinMessage

string

campaignOptoutKeywords

string

campaignOptoutMessage

string

campaignHelpKeywords

string

campaignHelpMessage

string

campaignEmbeddedLink

boolean

campaignEmbeddedLinkUrl

string

campaignEmbeddedPhone

boolean

campaignAgeGated

boolean

campaignDirectLending

boolean

campaignPrivacyPolicyLink

string

campaignTermsAndConditionsLink

string

campaignUsecase

string

createdAt

required

string

updatedAt

required

string

Example

{
  "campaignStatus": "not_started"
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}