> ## Documentation Index > Fetch the complete documentation index at: https://www.vobiz.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a campaign > Replaces the editable fields of a 10DLC campaign and pushes the change to the US 10DLC registry. This is a full replacement: `name` is required and any field you leave out is cleared. ## OpenAPI ````yaml openapi-sms.yaml PUT /10dlc/campaigns/{id} openapi: 3.0.3 info: title: Vobiz Messaging API description: > Send and receive SMS, MMS and RCS messages, buy messaging numbers, register for US 10DLC and toll-free, run broadcasts, manage conversations, opt-outs and webhooks. **Base URL:** `https://api.vobiz.ai/api/v1/sms` **Authentication:** every request needs the `X-Auth-ID` and `X-Auth-Token` headers. The account is taken from your credentials; you never put an account ID in a path or body. Field names in this API are camelCase. version: '1.0' contact: email: support@vobiz.ai url: https://vobiz.ai servers: - url: https://api.vobiz.ai/api/v1/sms description: Production security: - AuthID: [] AuthToken: [] tags: - name: Messages description: Send messages and inspect their delivery state. - name: Numbers description: >- Messaging-capable numbers on your account, inventory search, purchase and release. - name: Coverage description: Where you can send, per country. - name: Conversations description: Two-way threads between one of your numbers and a contact. - name: Opt-outs description: Numbers that must not receive messages on a channel. - name: Webhooks description: Subscriptions that deliver message and broadcast events to your server. - name: Broadcasts description: Bulk sends from an uploaded recipient list. - name: RCS Senders description: RCS sender (agent) identities and their message templates. - name: 10DLC Brands description: US 10DLC brand registration. - name: 10DLC Campaigns description: US 10DLC campaigns, toll-free verification and supporting documents. paths: /10dlc/campaigns/{id}: put: tags: - 10DLC Campaigns summary: Update a campaign description: >- Replaces the editable fields of a 10DLC campaign and pushes the change to the US 10DLC registry. This is a full replacement: `name` is required and any field you leave out is cleared. `campaignType` and the brand stay as created, and `referenceId` is ignored. The registry accepts updates while the campaign is `DRAFT` or `REJECTED`. Toll-free campaigns return `400` on this endpoint. operationId: update-campaign parameters: - name: id in: path required: true description: >- Campaign ID (UUID) returned by `POST /10dlc/campaigns` or `POST /10dlc/campaigns/toll-free`. An unknown ID, an ID from another account, or a value that is not a UUID returns `404` with `{"error":"campaign not found"}`. schema: type: string format: uuid example: 4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignRequest' example: name: Example Corp account alerts useCases: - ALERTS messageTypes: - SMS programSummary: >- Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help. confirmationMessage: >- Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out. helpMessage: >- Example Corp: For help email support@example.com. Reply STOP to opt out. stopMessage: 'Example Corp: You have been unsubscribed. Reply HELP for help.' exampleMessages: - >- Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out. customerCarePhone: '+14155550100' customerCareEmail: support@example.com termsAndConditionsUrl: https://example.com/terms privacyPolicyUrl: https://example.com/privacy optIns: web: url: https://example.com/signup callToAction: >- By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help. lowVolume: true embeddedLink: true responses: '200': description: The updated campaign. content: application/json: schema: $ref: '#/components/schemas/Campaign' example: id: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11 accountId: MA_XXXXXXXX brandId: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60 name: Example Corp account alerts campaignType: TEN_DIGIT_LONG_CODE stage: DRAFT programSummary: >- Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help. useCases: - ALERTS messageTypes: - SMS lowVolume: true ageGated: false directLending: false embeddedLink: true embeddedPhone: false createdAt: '2026-10-06T14:28:25Z' updatedAt: '2026-10-06T15:02:10Z' '400': description: Invalid body, a missing `name`, or a toll-free campaign. content: application/json: schema: $ref: '#/components/schemas/Error' examples: name: value: error: 'invalid request: name is required' tollFree: value: error: >- invalid request: toll-free campaigns cannot be updated through this endpoint '401': $ref: '#/components/responses/Unauthorized' '404': description: The campaign does not exist on your account. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: campaign not found '422': description: >- The US 10DLC registry declined the update, for example because the campaign is under review. `error` carries the registry's description. content: application/json: schema: $ref: '#/components/schemas/TenDLCError' example: error: >- registration provider rejected the request: campaign can only be updated in DRAFT or REJECTED stage providerError: >- registration error 403 (HTTP 403): campaign can only be updated in DRAFT or REJECTED stage '500': $ref: '#/components/responses/ServerError' '502': description: The US 10DLC registry did not answer. Retry the request. content: application/json: schema: $ref: '#/components/schemas/TenDLCError' example: error: registration provider unavailable providerError: 'registration error 500 (HTTP 500): upstream timeout' x-codeSamples: - lang: typescript label: Node SDK source: > import { VobizClient } from "@vobiz/sdk"; const client = new VobizClient({ apiKey: "MA_XXXXXXXX", authToken: "YOUR_AUTH_TOKEN" }); await client.sms.campaigns.updateCampaign({ id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", name: "Example Corp account alerts", programSummary: "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.", confirmationMessage: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.", helpMessage: "Example Corp: For help email support@example.com. Reply STOP to opt out.", stopMessage: "Example Corp: You have been unsubscribed. Reply HELP for help.", customerCarePhone: "+14155550100", customerCareEmail: "support@example.com", termsAndConditionsUrl: "https://example.com/terms", privacyPolicyUrl: "https://example.com/privacy", exampleMessages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out."], useCases: ["ALERTS"], messageTypes: ["SMS"], optIns: { "web": { "url": "https://example.com/signup", "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help." } }, lowVolume: true, embeddedLink: true }) - lang: python label: Python SDK source: | from vobiz import Vobiz client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN") client.sms.campaigns.update_campaign( id="4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", name="Example Corp account alerts", program_summary="Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.", confirmation_message="Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.", help_message="Example Corp: For help email support@example.com. Reply STOP to opt out.", stop_message="Example Corp: You have been unsubscribed. Reply HELP for help.", customer_care_phone="+14155550100", customer_care_email="support@example.com", terms_and_conditions_url="https://example.com/terms", privacy_policy_url="https://example.com/privacy", example_messages=[ "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out." ], use_cases=[ "ALERTS" ], message_types=[ "SMS" ], opt_ins={ "web": {"url": "https://example.com/signup", "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."} }, low_volume=True, embedded_link=True, ) - lang: go label: Go SDK source: | import ( "context" vobiz "github.com/vobiz-ai/Vobiz-Go-SDK" "github.com/vobiz-ai/Vobiz-Go-SDK/client" "github.com/vobiz-ai/Vobiz-Go-SDK/option" "github.com/vobiz-ai/Vobiz-Go-SDK/sms" ) c := client.NewClient( option.WithAPIKey("MA_XXXXXXXX"), option.WithAuthToken("YOUR_AUTH_TOKEN"), ) request := &sms.UpdateCampaignRequest{ ID: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", Name: vobiz.String( "Example Corp account alerts", ), ProgramSummary: vobiz.String( "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.", ), ConfirmationMessage: vobiz.String( "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.", ), HelpMessage: vobiz.String( "Example Corp: For help email support@example.com. Reply STOP to opt out.", ), StopMessage: vobiz.String( "Example Corp: You have been unsubscribed. Reply HELP for help.", ), CustomerCarePhone: vobiz.String( "+14155550100", ), CustomerCareEmail: vobiz.String( "support@example.com", ), TermsAndConditionsURL: vobiz.String( "https://example.com/terms", ), PrivacyPolicyURL: vobiz.String( "https://example.com/privacy", ), ExampleMessages: []string{ "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.", }, UseCases: []string{ "ALERTS", }, MessageTypes: []string{ "SMS", }, OptIns: map[string]any{ "web": map[string]any{ "callToAction": "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.", "url": "https://example.com/signup", }, }, LowVolume: vobiz.Bool( true, ), EmbeddedLink: vobiz.Bool( true, ), } c.Sms.Campaigns.UpdateCampaign( context.TODO(), request, ) - lang: java label: Java SDK source: | import com.vobiz.api.VobizApiClient; VobizApiClient client = VobizApiClient .builder() .apiKey("MA_XXXXXXXX") .authToken("YOUR_AUTH_TOKEN") .build(); client.sms().campaigns().updateCampaign( "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", UpdateCampaignRequest .builder() .name("Example Corp account alerts") .programSummary("Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.") .confirmationMessage("Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.") .helpMessage("Example Corp: For help email support@example.com. Reply STOP to opt out.") .stopMessage("Example Corp: You have been unsubscribed. Reply HELP for help.") .customerCarePhone("+14155550100") .customerCareEmail("support@example.com") .termsAndConditionsUrl("https://example.com/terms") .privacyPolicyUrl("https://example.com/privacy") .exampleMessages( Optional.of( Arrays.asList("Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.") ) ) .useCases( Optional.of( Arrays.asList("ALERTS") ) ) .messageTypes( Optional.of( Arrays.asList("SMS") ) ) .optIns( new HashMap() {{ put("web", new HashMap() {{put("url", "https://example.com/signup"); put("callToAction", "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help."); }}); }} ) .lowVolume(true) .embeddedLink(true) .build() ); - lang: ruby label: Ruby SDK source: > require 'vobiz' client = Vobiz::Client.new(api_key: 'MA_XXXXXXXX', auth_token: 'YOUR_AUTH_TOKEN') client.sms.campaigns.update_campaign( id: "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", name: "Example Corp account alerts", program_summary: "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.", confirmation_message: "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.", help_message: "Example Corp: For help email support@example.com. Reply STOP to opt out.", stop_message: "Example Corp: You have been unsubscribed. Reply HELP for help.", customer_care_phone: "+14155550100", customer_care_email: "support@example.com", terms_and_conditions_url: "https://example.com/terms", privacy_policy_url: "https://example.com/privacy", example_messages: ["Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out."], use_cases: ["ALERTS"], message_types: ["SMS"], opt_ins: {}, low_volume: true, embedded_link: true ) - lang: csharp label: C# SDK source: | using Vobiz; using Vobiz.Sms; var client = new VobizApiClient("YOUR_AUTH_TOKEN", "MA_XXXXXXXX"); await client.Sms.Campaigns.UpdateCampaignAsync( new UpdateCampaignRequest { Id = "4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24", Name = "Example Corp account alerts", ProgramSummary = "Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.", ConfirmationMessage = "Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.", HelpMessage = "Example Corp: For help email support@example.com. Reply STOP to opt out.", StopMessage = "Example Corp: You have been unsubscribed. Reply HELP for help.", CustomerCarePhone = "+14155550100", CustomerCareEmail = "support@example.com", TermsAndConditionsUrl = "https://example.com/terms", PrivacyPolicyUrl = "https://example.com/privacy", ExampleMessages = new List() { "Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.", }, UseCases = new List() { "ALERTS" }, MessageTypes = new List() { "SMS" }, OptIns = new Dictionary() { { "web", new Dictionary() { { "callToAction", "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help." }, { "url", "https://example.com/signup" }, } }, }, LowVolume = true, EmbeddedLink = true, } ); - lang: php label: PHP SDK source: > sms->campaigns->updateCampaign( '4c2a0e8d-6b4f-4d2c-b0a8-9e7c5a3f1d24', new UpdateCampaignRequest([ 'name' => 'Example Corp account alerts', 'programSummary' => 'Example Corp sends account, billing and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help.', 'confirmationMessage' => 'Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out.', 'helpMessage' => 'Example Corp: For help email support@example.com. Reply STOP to opt out.', 'stopMessage' => 'Example Corp: You have been unsubscribed. Reply HELP for help.', 'customerCarePhone' => '+14155550100', 'customerCareEmail' => 'support@example.com', 'termsAndConditionsUrl' => 'https://example.com/terms', 'privacyPolicyUrl' => 'https://example.com/privacy', 'exampleMessages' => [ 'Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out.', ], 'useCases' => [ 'ALERTS', ], 'messageTypes' => [ 'SMS', ], 'optIns' => [ 'web' => [ 'url' => "https://example.com/signup", 'callToAction' => "By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help.", ], ], 'lowVolume' => true, 'embeddedLink' => true, ]), ); components: schemas: UpdateCampaignRequest: allOf: - $ref: '#/components/schemas/CampaignFields' - type: object required: - name description: >- Full replacement of the campaign's editable fields. `campaignType` and the brand stay as created. description: >- Full replacement body for a 10DLC campaign update: the shared campaign fields. `name` is required and any field you leave out is cleared; `campaignType` and the brand stay as created. Campaign: type: object description: >- A 10DLC or toll-free campaign on your account and its state at the US 10DLC registry. Optional fields are omitted when empty, and registry state is refreshed when you retrieve the campaign. properties: id: type: string format: uuid description: >- Campaign ID (UUID) on your account. Use it in every `/10dlc/campaigns/{id}` path. example: 8a7d2f10-3c4b-4e9a-b1d2-6e5f4a3b2c11 accountId: type: string example: MA_XXXXXXXX description: >- Your Vobiz account ID (`MA_...`). Always the account whose credentials made the request. brandId: type: string format: uuid description: >- ID of the brand the campaign runs under. Omitted for toll-free campaigns, which carry their business details themselves. example: 5f1c3a2e-7b4d-4e8f-9a0b-1c2d3e4f5a60 name: type: string example: Example Corp account alerts description: Name you gave the campaign, for your reference. campaignType: type: string enum: - TEN_DIGIT_LONG_CODE - TOLL_FREE_UNIFIED_NUMBER - TOLL_FREE_NUMBER - SHORT_CODE - EXTERNAL_TEN_DIGIT_LONG_CODE - DCA2_TEN_DIGIT_LONG_CODE - TOLL_FREE_EXTERNALLY_VERIFIED - RCS_SENDER_LAUNCH description: >- Kind of campaign. `TEN_DIGIT_LONG_CODE` is a standard 10DLC campaign (the default on create) and `TOLL_FREE_UNIFIED_NUMBER` is a toll-free verification created with `POST /10dlc/campaigns/toll-free`. The other values are registry campaign types you can request on create. stage: type: string description: >- Registry lifecycle stage. A new campaign is `DRAFT`; after you register it, it moves through review stages such as `SUBMITTED`, `IN_REVIEW` or `APPEALED` and settles at `REGISTERED` or `REJECTED`. Other values include `REGISTERED_PENDING_UPDATE`, `REGISTERED_PENDING_DEREGISTRATION`, `REJECTED_EXTERNALLY`, `DEREGISTERED`, `ARCHIVED`, `BLOCKED`, `SUSPENDED` and `DELETED`; treat it as an open string. example: REGISTERED programSummary: type: string description: >- Description of the program as submitted to the registry. Omitted when not set. confirmationMessage: type: string description: Opt-in confirmation message as submitted. Omitted when not set. helpMessage: type: string description: HELP reply as submitted. Omitted when not set. stopMessage: type: string description: STOP reply as submitted. Omitted when not set. customerCarePhone: type: string example: '+14155550100' description: Customer care phone number, in E.164 format. Omitted when not set. customerCareEmail: type: string example: support@example.com description: Customer care email address. Omitted when not set. exampleMessages: type: array items: type: string description: Sample messages as submitted. Omitted when not set. termsAndConditionsUrl: type: string format: uri description: Public URL of your terms and conditions. Omitted when not set. privacyPolicyUrl: type: string format: uri description: Public URL of your privacy policy. Omitted when not set. useCases: type: array items: type: string example: - ALERTS description: >- Use-case codes as submitted, for example `ALERTS` or, on a toll-free campaign, `NOTIFICATIONS`. Omitted when not set. messageTypes: type: array items: type: string example: - SMS description: Message types as submitted, for example `SMS`. Omitted when not set. optIns: type: object description: >- Opt-in details as submitted, keyed by channel (for example `web`). Omitted when not set. additionalProperties: true lowVolume: type: boolean description: >- Whether the campaign is declared low volume. Always present; `false` unless you set it. ageGated: type: boolean description: >- Whether the content is restricted to adults. Always present; `false` unless you set it. directLending: type: boolean description: >- Whether the content relates to direct lending. Always present; `false` unless you set it. embeddedLink: type: boolean description: >- Whether messages contain URLs. Always present; `false` unless you set it. embeddedPhone: type: boolean description: >- Whether messages contain phone numbers. Always present; `false` unless you set it. numbers: type: array description: >- Numbers recorded on the campaign on your account. 10DLC campaigns store digits with country code (for example `14155550100`); toll-free campaigns store E.164 with a leading `+`. For the registry's own list use `GET /10dlc/campaigns/{id}/numbers`. items: type: string example: - '14155550100' rejectionReasons: type: object description: >- The registry's review feedback after a rejection, with keys such as `rejectionDate`, `rejectionReasons` and `rejectionDetails` (each detail has `errorCode`, `description`, `recommendedAction` and `rejectionCategory`). Omitted when the campaign has no feedback; address every point before you appeal. additionalProperties: true lastSyncedAt: type: string format: date-time description: >- When Vobiz last refreshed this record from the US 10DLC registry, in ISO 8601 (RFC 3339) UTC. Omitted until the first refresh. example: '2026-10-14T17:19:03Z' createdAt: type: string format: date-time example: '2026-10-06T14:28:25Z' description: >- When the record was created on your account, in ISO 8601 (RFC 3339) UTC. updatedAt: type: string format: date-time example: '2026-10-14T17:19:03Z' description: >- When the record last changed on your account, in ISO 8601 (RFC 3339) UTC. Error: type: object description: >- The body of every error response: a flat object with one `error` string that explains what went wrong. Use the HTTP status code to decide how to handle the error, and log `error` for diagnosis. required: - error properties: error: type: string example: 'recipient has opted out: +14155550123' description: >- Human-readable explanation of the error, for example `phoneNumber is required` or `recipient has opted out: +14155550123`. Branch on the HTTP status code rather than on this text. TenDLCError: description: >- Error returned when the US 10DLC registry declines or cannot process a request. `error` is a human-readable message you can show or log. When the registry answers with `400`, `404`, `409`, `422` or `429`, the same status is passed through with this body; `502` means the registry did not answer and `503` means it did not accept Vobiz's service credentials. allOf: - $ref: '#/components/schemas/Error' - type: object properties: providerError: type: string description: >- Opaque diagnostic string you can quote to support. Do not parse it. example: 'registration error 400 (HTTP 400): brand legalName is required' CampaignFields: type: object description: >- Fields shared by campaign create and update requests. Values are passed to the US 10DLC registry as given, and reviewers check them against your brand and website. properties: name: type: string description: >- Name for the campaign, for your reference. Required on create and on update. example: Example Corp account alerts programSummary: type: string description: >- Plain-language description of the program: what you send, to whom, how often and how recipients opt in. Reviewers read this first. example: >- Example Corp sends account and support alerts to customers who opted in on the sign-up form. Reply STOP to opt out, HELP for help. confirmationMessage: type: string description: >- Message you send when a recipient opts in. Include your brand name and how to get help or opt out. example: >- Example Corp: You are subscribed to account alerts. Msg frequency varies. Msg & data rates may apply. Reply HELP for help, STOP to opt out. helpMessage: type: string description: >- Reply you send when a recipient texts HELP. Include your brand name and a way to reach support. example: >- Example Corp: For help email support@example.com. Reply STOP to opt out. stopMessage: type: string description: >- Reply you send when a recipient texts STOP, confirming they will receive no further messages. example: 'Example Corp: You have been unsubscribed. Reply HELP for help.' customerCarePhone: type: string example: '+14155550100' description: Customer care phone number for the program, in E.164 format. customerCareEmail: type: string format: email example: support@example.com description: Customer care email address for the program. termsAndConditionsUrl: type: string format: uri example: https://example.com/terms description: Public URL of the terms and conditions that cover the program. privacyPolicyUrl: type: string format: uri example: https://example.com/privacy description: Public URL of your privacy policy. exampleMessages: type: array description: >- Sample messages exactly as the campaign will send them, including your brand name and opt-out language. Cover each use case you list. items: type: string example: - >- Example Corp: Your support ticket #48213 was updated. View it at https://example.com/support. Reply STOP to opt out. useCases: type: array description: >- Use-case codes the campaign covers. Values accepted by the US 10DLC registry: `TWO_FACTOR_AUTH`, `ALERTS`, `FRAUD_ALERTS`, `CHAT`, `PROMOTIONAL_MARKETING`, `EDUCATION`, `DONATION`, `PUBLIC_SERVICE_ANNOUNCEMENT`, `VOTING_POLLING`, `POLITICAL`, `M2M`, `SWEEPSTAKE`. items: type: string example: - ALERTS messageTypes: type: array description: Message types the campaign sends, for example `SMS` and `MMS`. items: type: string example: - SMS optIns: type: object description: >- How recipients give consent, as an object keyed by opt-in channel (for example `web`, `keyword`, `paper`). Each entry describes that flow, for example `url` and `callToAction` for `web`; the object is passed to the registry as given. additionalProperties: true example: web: url: https://example.com/signup callToAction: >- By checking this box you agree to receive account alerts from Example Corp. Msg frequency varies. Msg & data rates may apply. Reply STOP to opt out, HELP for help. lowVolume: type: boolean default: false description: >- Declares the campaign as low volume to the registry. Defaults to `false`. ageGated: type: boolean default: false description: >- Set `true` when the content is restricted to adults. Defaults to `false`. directLending: type: boolean default: false description: >- Set `true` when the content relates to direct lending or loan arrangements. Defaults to `false`. embeddedLink: type: boolean default: false description: Set `true` when messages contain URLs. Defaults to `false`. embeddedPhone: type: boolean default: false description: Set `true` when messages contain phone numbers. Defaults to `false`. numbers: type: array description: >- Numbers on your account to attach to the campaign, as digits with country code and no `+` (for example `14155550100`). items: type: string example: - '14155550100' supportingDocuments: type: array description: >- `documentId` values of supporting documents uploaded with `POST /10dlc/documents`. Every ID must be on your account, otherwise the request returns `400`. items: type: string format: uuid mmsSampleFiles: type: array description: >- `documentId` values of MMS sample files uploaded with `POST /10dlc/documents`. Every ID must be on your account, otherwise the request returns `400`. items: type: string format: uuid responses: Unauthorized: description: Missing or invalid `X-Auth-ID` / `X-Auth-Token`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: missing or invalid credentials ServerError: description: Unexpected error. Retry with the same idempotency key where one applies. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: internal error securitySchemes: AuthID: type: apiKey in: header name: X-Auth-ID description: Your Vobiz account Auth ID (`MA_XXXXXXXX`). AuthToken: type: apiKey in: header name: X-Auth-Token description: Your Vobiz account Auth Token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.