{"items":[{"type":"group","fsPath":"docs/campaigns/index.md","metadata":{"type":"markdown"},"label":"US Short Code Campaign Registration","link":"/docs/campaigns","routeSlug":"/docs/campaigns","items":[{"type":"group","fsPath":"docs/campaigns/getting-started/index.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/docs/campaigns/getting-started","routeSlug":"/docs/campaigns/getting-started","items":[{"type":"link","fsPath":"docs/campaigns/getting-started/register-campaign.md","metadata":{"type":"markdown"},"label":"Register a campaign","link":"/docs/campaigns/getting-started/register-campaign","routeSlug":"/docs/campaigns/getting-started/register-campaign"}]},{"type":"group","label":"API reference","items":[{"type":"link","fsPath":"docs/campaigns/api-reference/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/docs/campaigns/api-reference","routeSlug":"/docs/campaigns/api-reference"},{"type":"link","label":"Sinch US ShortCode Campaigns API","link":"/docs/campaigns/api-reference/campaigns","routeSlug":"/docs/campaigns/api-reference/campaigns"},{"type":"group","label":"Campaigns Callbacks","link":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks","items":[{"label":"Get a callback configuration by project id.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/getcallbackconfiguration","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/getcallbackconfiguration","metadata":{"seo":{"title":"Get a callback configuration by project id.","description":"The endpoint receives as path param project id. If the project exists, the details of the callback configuration are returned."}},"httpPath":"/v1/projects/{projectId}/callback-configuration"},{"label":"Update a callback configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/updatecallbackconfiguration","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/updatecallbackconfiguration","metadata":{"seo":{"title":"Update a callback configuration","description":"The endpoint updates the callback configuration with specified project ID"}},"httpPath":"/v1/projects/{projectId}/callback-configuration"},{"type":"separator","label":"Webhooks","variant":"secondary"},{"label":"Event notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/eventscallback","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns-callbacks/eventscallback","metadata":{"seo":{"title":"Event notification","description":"A notification of an event sent to your configured callback URL."}},"httpPath":"EventsCallback"}]},{"type":"group","label":"Campaigns","link":"/docs/campaigns/api-reference/campaigns/campaigns","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns","items":[{"label":"Create US SC Campaign Draft","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/createcampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/createcampaign","metadata":{"seo":{"title":"Create US SC Campaign Draft","description":"Create a new US Short Code Campaign Draft. Draft requirements are based on the requirement fields, but extra validations are applied at submission time."}},"httpPath":"/v1/projects/{projectId}/campaigns"},{"label":"List US SC Campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/listcampaigns","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/listcampaigns","metadata":{"seo":{"title":"List US SC Campaigns","description":"List campaigns based on filters provided"}},"httpPath":"/v1/projects/{projectId}/campaigns"},{"label":"Create and Submit US SC Campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/createandsubmitcampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/createandsubmitcampaign","metadata":{"seo":{"title":"Create and Submit US SC Campaign","description":"Create and submit a new US Short Code Campaign in a single step. Both draft and submission requirements will be validated together."}},"httpPath":"/v1/projects/{projectId}/campaigns:submit"},{"label":"Update US SC Campaign","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/updatecampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/updatecampaign","metadata":{"seo":{"title":"Update US SC Campaign","description":"Update a US Short Code Campaign. The campaign must be in DRAFT or AWAITING_CLIENT_UPDATE status to be updated. If the campaign is in any other status, an error will be returned."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}"},{"label":"Get US SC Campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/getcampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/getcampaign","metadata":{"seo":{"title":"Get US SC Campaign","description":"Get a US Short Code Campaign by campaign ID."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}"},{"label":"Submit US SC Campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/submitcampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/submitcampaign","metadata":{"seo":{"title":"Submit US SC Campaign","description":"Submit a US Short Code Campaign for review. The campaign must be in DRAFT or AWAITING_CLIENT_UPDATE status to be submitted. If the campaign is in any other status, an error will be returned. The submission of a campaign applies some extra validations that are not applied when creating or updating a campaign. This document contains all these validations per field."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}:submit"},{"label":"Cancel US SC Campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/cancelcampaign","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/cancelcampaign","metadata":{"seo":{"title":"Cancel US SC Campaign","description":"Cancel a US Short Code Campaign. The campaign is not deleted, but moved to cancelled status. The campaign must be in DRAFT, PENDING_REVIEW or AWAITING_CLIENT_UPDATE status to be cancelled. If the campaign is in any other status, an error will be returned."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}:cancel"},{"label":"Add US SC Campaign Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/addcampaignnote","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/addcampaignnote","metadata":{"seo":{"title":"Add US SC Campaign Note","description":"Add a note to a US Short Code Campaign. The note is added to the campaign and can be used to communicate with backoffice teams. The note is not mandatory and can be added at any time."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}/notes"},{"label":"Add US SC Campaign - Carrier Order Note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/addcarrierordernote","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/addcarrierordernote","metadata":{"seo":{"title":"Add US SC Campaign - Carrier Order Note","description":"Add a note to a US Short Code Campaign - Carrier Order. The note is added to the carrier order and can be used to communicate with backoffice teams. The note is not mandatory and can be added at any time."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}/carriers/{carrierOrderId}/notes"},{"label":"Request Client Certificate for US SC Campaign - Carrier Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/requestcarrierordercertification","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/requestcarrierordercertification","metadata":{"seo":{"title":"Request Client Certificate for US SC Campaign - Carrier Order","description":"Request client certification for a US Short Code Campaign - Carrier Order. The carrier order must be in PROVISIONED_BY_SINCH status to request the client certification. If the carrier order is in any other status, an error will be returned."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}/carriers/{carrierOrderId}/request-certification"},{"label":"Get Carriers List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/getcarriers","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/getcarriers","metadata":{"seo":{"title":"Get Carriers List","description":"Get a list of carriers available for a campaign. When creating a new campaign, add the carrier ids in the carriers field, therefore Sinch will configure the campaign with those carriers selected."}},"httpPath":"/v1/projects/{projectId}/carriers"},{"label":"Upload US SC Campaign Attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/uploadattachment","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/uploadattachment","metadata":{"seo":{"title":"Upload US SC Campaign Attachment","description":"Upload a file to a US Short Code Campaign. Attachments are needed when bringing a SC or migrating a campaign, but they can also be required by backoffice team. If you are filing campaigns for US Short codes and you have already procured your Short code from CSCA, please make sure that you attach your Short code receipt (proof of identity). If MMS is a message type for this campaign, please submit a .jpg or .png example."}},"httpPath":"/v1/projects/{projectId}/attachments"},{"label":"Download US SC Campaign Attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/downloadcampaignattachment","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/downloadcampaignattachment","metadata":{"seo":{"title":"Download US SC Campaign Attachment","description":"Download a file from a US Short Code Campaign."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}/attachments/{attachmentId}"},{"label":"Delete US SC Campaign Attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/campaigns/api-reference/campaigns/campaigns/deletecampaignattachment","routeSlug":"/docs/campaigns/api-reference/campaigns/campaigns/deletecampaignattachment","metadata":{"seo":{"title":"Delete US SC Campaign Attachment","description":"Delete a file from a US Short Code Campaign."}},"httpPath":"/v1/projects/{projectId}/campaigns/{campaignId}/attachments/{attachmentId}"}]}],"selectFirstItemOnExpand":true}]}]}