{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/campaigns/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Register a new campaign","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for every Sinch API and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]},"description":"Learn how to register a new campaign."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"getting-started-with-registering-a-campaign","__idx":0},"children":["Getting started with registering a campaign"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To register a brand, follow these steps:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#createandsubmit-campaign"},"children":["Create and submit campaign"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#upload-an-attachment"},"children":["Upload an attachment"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#request-client-certification"},"children":["Request client certification"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":1},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API endpoints described below require authentication. You can authenticate your requests using one of the following two methods for the Authorization header:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Bearer Token:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"    Authorization: Bearer <YourJwtToken>\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic Authentication:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"    Authorization: Basic <YourBase64EncodedCredentials>\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"createandsubmit-campaign","__idx":2},"children":["CreateAndSubmit Campaign"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows for the creation and submission of a new campaign in a single API call. All fields are mandatory except for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notes"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["complianceEmails"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrierIds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["termsAndConditions.text"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["privacyPolicy.text"]},", which are optional fields. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scRequested=false"]},", then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shortcode"]}," is mandatory, otherwise, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["brandId"]}," is mandatory. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrierIds"]}," are not present, all available ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrierIds"]}," are automatically included."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following curl command demonstrates how to create and submit a new campaign:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://campaigns-api.numbers-registration.prod.sinch.com/v1/projects/<projectId>/campaigns:submit\"\n  -H \"Authorization: Bearer <JWT Token>\"\n  -H \"Content-Type: application/json\"\n  -d '{\n    \"name\": \"Test Campaign\",\n    \"trafficCharge\": \"STANDARD\",\n    \"scRequested\": true,\n    \"description\": \"New campaign\",\n    \"contactEmails\": [\"contact@sinch.com\"],\n    \"complianceEmails\": [\"compliance@sinch.com\"],\n    \"brandId\": \"01k7h5y64mh4fwcmxxa48h9m75\",\n    \"isMigrated\": false,\n    \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\",\n    \"notes\": [\"Initial note\"],\n    \"carrierIds\": [\"1\", \"2\", \"4\"],\n    \"customerCare\": {\n      \"optOutKeywords\": \"OPT Out Keywords\",\n      \"optOutMtText\": \"Opt Out Mt text\",\n      \"helpMtText\": \"Help My Text\",\n      \"email\": \"eded@sinch.com\",\n      \"website\": \"https://website.com\",\n      \"phoneNumber\": \"+346555555555\"\n    },\n    \"contentDefinitions\": [\n    {\n      \"messageType\": \"SMS\",\n      \"contentType\": \"INFORMATIONAL_ALERTS\",\n      \"subscription\": \"ONE_TIME\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 1\",\n        \"optIn\": \"Opt In\",\n        \"sampleAlert\": \"Sample Alert\"\n      }\n    },\n    {\n      \"messageType\": \"MMS_VIDEO\",\n      \"contentType\": \"ENTERTAINMENT_ALERTS\",\n      \"subscription\": \"SUBSCRIPTION\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 2\",\n        \"optIn\": \"Opt In 2\",\n        \"sampleAlert\": \"Sample Alert2\"\n      }\n    }],\n    \"termsAndConditions\": {\n      \"text\": \"My terms text\",\n      \"url\": \"https://www.mycompany.com/myterms\"\n    },\n    \"privacyPolicy\": {\n      \"text\": \"My Privacy Policy\",\n      \"url\": \"https://www.mycompany.com/policy\"\n    },\n    \"attachments\": [\"663\"]\n  }'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"campaignId\": \"8834\",\n  \"name\": \"Test Campaign\",\n  \"description\": \"New campaign\",\n  \"trafficCharge\": \"STANDARD\",\n  \"status\": \"PENDING_REVIEW\",\n  \"scRequested\": true,\n  \"brandId\": \"01k7h5y64mh4fwcmxxa48h9m75\",\n  \"customerCare\": {\n    \"optOutKeywords\": \"OPT Out Keywords\",\n    \"optOutMtText\": \"Opt Out Mt text\",\n    \"helpMtText\": \"Help My Text\",\n    \"email\": \"eded@sinch.com\",\n    \"website\": \"https://website.com\",\n    \"phoneNumber\": \"+346555555555\"\n  },\n  \"contentDefinitions\": [\n    {\n      \"contentType\": \"INFORMATIONAL_ALERTS\",\n      \"messageType\": \"SMS\",\n      \"subscription\": \"ONE_TIME\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 1\",\n        \"optIn\": \"Opt In\",\n        \"sampleAlert\": \"Sample Alert\"\n      }\n    },\n    {\n      \"contentType\": \"ENTERTAINMENT_ALERTS\",\n      \"messageType\": \"MMS_VIDEO\",\n      \"subscription\": \"SUBSCRIPTION\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 2\",\n        \"optIn\": \"Opt In 2\",\n        \"sampleAlert\": \"Sample Alert2\"\n      }\n    }\n  ],\n  \"termsAndConditions\": {\n    \"text\": \"My terms text\",\n    \"url\": \"https://www.mycompany.com/myterms\"\n  },\n  \"privacyPolicy\": {\n    \"text\": \"My Privacy Policy\",\n    \"url\": \"https://www.mycompany.com/policy\"\n  },\n  \"complianceEmails\": [\n    \"compliance1@sinch.com\",\n    \"compliance2@sinch.com\"\n  ],\n  \"contactEmails\": [\n    \"myemail@sinch.com\",\n    \"borja.pilarte@sinch.com\"\n  ],\n  \"callbackUrl\": \"https://webhook.site/d73ba377-90c3-4029-9a99-fe5a7d485b49\",\n  \"isMigrated\": false,\n  \"carrierOrders\": [\n    {\n      \"carrierOrderId\": \"71052\",\n      \"carrierId\": \"1\",\n      \"carrierName\": \"AT&T Mobility\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:12Z\",\n      \"updatedAt\": \"2025-11-19T10:12:12Z\"\n    },\n    {\n      \"carrierOrderId\": \"71053\",\n      \"carrierId\": \"2\",\n      \"carrierName\": \"Verizon Wireless\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:13Z\",\n      \"updatedAt\": \"2025-11-19T10:12:13Z\"\n    },\n    {\n      \"carrierOrderId\": \"71054\",\n      \"carrierId\": \"4\",\n      \"carrierName\": \"T-Mobile & MetroPCS\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:13Z\",\n      \"updatedAt\": \"2025-11-19T10:12:13Z\"\n    }\n  ],\n  \"campaignAttachments\": [\n    {\n      \"attachmentId\": \"663\",\n      \"name\": \"myAttachment.pdf\",\n      \"description\": \"proof of ownership\"\n    }\n  ],\n  \"logs\": [\n    {\n      \"previousStatus\": \"DRAFT\",\n      \"currentStatus\": \"PENDING_REVIEW\",\n      \"createdAt\": \"2025-11-19T10:12:13Z\"\n    }\n  ],\n  \"notes\": [\n    {\n      \"author\": \"CUSTOMER\",\n      \"text\": \"Initial note\",\n      \"createdAt\": \"2025-11-19T10:12:13Z\"\n    }\n  ],\n  \"createdAt\": \"2025-11-19T10:12:12Z\",\n  \"updatedAt\": \"2025-11-19T10:12:13Z\"\n} \n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upload-an-attachment","__idx":3},"children":["Upload an attachment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An attachment can be uploaded for project:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -X POST --location 'https://campaigns.numbers-registration.staging.sinch.com/v1/projects/<projectId>/attachments'\n  -H \"Authorization: Bearer <JWT Token>\" \n  --form 'file=@\"<file_location>\"'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-client-certification","__idx":4},"children":["Request Client Certification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the Carrier Order is in Provisioned by Sinch state, the Request Client Certification may be called:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://campaigns.numbers-registration.staging.sinch.com/v1/projects/<projectId>/campaigns/<campaignId>/carriers/<carrierOrderId>/request-certification\n  -H \"Authorization: Bearer <JWT Token>\"\n  -H \"Content-Type: application/json\"\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"carrierOrderId\": \"69635\",\n    \"carrierId\": \"1\",\n    \"carrierName\": \"AT&T Mobility\",\n    \"status\": \"CLIENT_CERTIFICATION_REQUESTED\",\n    \"notes\": [],\n    \"logs\": [\n        {\n            \"previousStatus\": \"PENDING\",\n            \"currentStatus\": \"SUBMITTED\",\n            \"createdAt\": \"2025-10-20T09:15:11Z\"\n        },\n        {\n            \"previousStatus\": \"SUBMITTED\",\n            \"currentStatus\": \"APPROVED\",\n            \"createdAt\": \"2025-10-20T09:15:28Z\"\n        },\n        {\n            \"previousStatus\": \"APPROVED\",\n            \"currentStatus\": \"PROVISIONED_BY_CARRIER\",\n            \"createdAt\": \"2025-10-20T09:15:45Z\"\n        },\n        {\n            \"previousStatus\": \"PROVISIONED_BY_CARRIER\",\n            \"currentStatus\": \"PROVISIONED_BY_SINCH\",\n            \"createdAt\": \"2025-10-20T09:59:02Z\"\n        },\n        {\n            \"previousStatus\": \"PROVISIONED_BY_SINCH\",\n            \"currentStatus\": \"CLIENT_CERTIFICATION_REQUESTED\",\n            \"createdAt\": \"2025-10-20T10:04:13Z\"\n        }\n    ],\n    \"createdAt\": \"2025-10-15T15:20:05Z\",\n    \"updatedAt\": \"2025-10-20T10:04:13Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"update-campaign","__idx":5},"children":["Update Campaign"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This endpoint allows you to modify the details of an existing campaign."," ","To use it, you must specify which campaign to update by including campaignId in the API endpoint's URL."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":"curl -X PUT \"https://campaigns.numbers-registration.staging.sinch.com/v1/projects/<projectId>/campaigns/<campaignId>\"\n  -H \"Authorization: Bearer <JWT Token>\"\n  -H \"Content-Type: application/json\"\n  -d '{\n  \"name\": \"A new Campaign Created DEMO III\",\n  \"trafficCharge\": \"STANDARD\",\n  \"scRequested\": true,\n  \"shortcode\": \"\",\n  \"brandId\": \"01k6n04h28hn8m29a77ee3bj4p\",\n  \"description\": \"My Description\",\n  \"contactEmails\": [\"myemail@sinch.com\", \"myemail2@sinch.com\"],\n  \"complianceEmails\": [\"compliance1@sinch.com\", \"compliance2@sinch.com\"],\n  \"carrierIds\": [\"1\", \"2\", \"4\"],\n  \"customerCare\": {\n    \"optOutKeywords\": \"OPT Out Keywords\",\n    \"optOutMtText\": \"Opt Out Mt text\",\n    \"helpMtText\": \"Help My Text\",\n    \"email\": \"eded@sinch.com\",\n    \"website\": \"https://website.com\",\n    \"phoneNumber\": \"+346555555555\"\n  },\n  \"contentDefinitions\": [\n    {\n      \"messageType\": \"SMS\",\n      \"contentType\": \"INFORMATIONAL_ALERTS\",\n      \"subscription\": \"ONE_TIME\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 1\",\n        \"optIn\": \"Opt In\",\n        \"sampleAlert\": \"Sample Alert\"\n      }\n    },\n    {\n      \"messageType\": \"MMS_VIDEO\",\n      \"contentType\": \"ENTERTAINMENT_ALERTS\",\n      \"subscription\": \"SUBSCRIPTION\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 2\",\n        \"optIn\": \"Opt In 2\",\n        \"sampleAlert\": \"Sample Alert2\"\n      }\n    }\n  ],\n  \"termsAndConditions\": {\n    \"text\": \"My terms text\",\n    \"url\": \"https://www.mycompany.com/myterms\"\n  },\n  \"privacyPolicy\": {\n    \"text\": \"My Privacy Policy\",\n    \"url\": \"https://www.mycompany.com/policy\"\n  },\n  \"isMigrated\": false,\n  \"callbackUrl\": \"https://webhook.site/dab8449d-aea8-4a8b-b98b-01ad3406b38d\",\n  \"attachments\": [\"663\"]\n}'\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"campaignId\": \"8834\",\n  \"name\": \"A new Campaign Created DEMO III\",\n  \"description\": \"My Description\",\n  \"trafficCharge\": \"STANDARD\",\n  \"status\": \"AWAITING_CLIENT_UPDATE\",\n  \"scRequested\": true,\n  \"brandId\": \"01k6n04h28hn8m29a77ee3bj4p\",\n  \"shortcode\": \"\",\n  \"customerCare\": {\n    \"optOutKeywords\": \"OPT Out Keywords\",\n    \"optOutMtText\": \"Opt Out Mt text\",\n    \"helpMtText\": \"Help My Text\",\n    \"email\": \"eded@sinch.com\",\n    \"website\": \"https://website.com\",\n    \"phoneNumber\": \"+346555555555\"\n  },\n  \"contentDefinitions\": [\n    {\n      \"contentType\": \"INFORMATIONAL_ALERTS\",\n      \"messageType\": \"SMS\",\n      \"subscription\": \"ONE_TIME\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 1\",\n        \"optIn\": \"Opt In\",\n        \"sampleAlert\": \"Sample Alert\"\n      }\n    },\n    {\n      \"contentType\": \"ENTERTAINMENT_ALERTS\",\n      \"messageType\": \"MMS_VIDEO\",\n      \"subscription\": \"SUBSCRIPTION\",\n      \"messageFlow\": {\n        \"callToAction\": \"Call 2\",\n        \"optIn\": \"Opt In 2\",\n        \"sampleAlert\": \"Sample Alert2\"\n      }\n    }\n  ],\n  \"termsAndConditions\": {\n    \"text\": \"My terms text\",\n    \"url\": \"https://www.mycompany.com/myterms\"\n  },\n  \"privacyPolicy\": {\n    \"text\": \"My Privacy Policy\",\n    \"url\": \"https://www.mycompany.com/policy\"\n  },\n  \"complianceEmails\": [\n    \"compliance1@sinch.com\",\n    \"compliance2@sinch.com\"\n  ],\n  \"contactEmails\": [\n    \"myemail@sinch.com\",\n    \"myemail2@sinch.com\"\n  ],\n  \"callbackUrl\": \"https://webhook.site/dab8449d-aea8-4a8b-b98b-01ad3406b38d\",\n  \"isMigrated\": false,\n  \"carrierOrders\": [\n    {\n      \"carrierOrderId\": \"71052\",\n      \"carrierId\": \"1\",\n      \"carrierName\": \"AT&T Mobility\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:12Z\",\n      \"updatedAt\": \"2025-11-19T10:12:12Z\"\n    },\n    {\n      \"carrierOrderId\": \"71053\",\n      \"carrierId\": \"2\",\n      \"carrierName\": \"Verizon Wireless\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:13Z\",\n      \"updatedAt\": \"2025-11-19T10:12:13Z\"\n    },\n    {\n      \"carrierOrderId\": \"71054\",\n      \"carrierId\": \"4\",\n      \"carrierName\": \"T-Mobile & MetroPCS\",\n      \"status\": \"PENDING\",\n      \"notes\": [],\n      \"logs\": [],\n      \"createdAt\": \"2025-11-19T10:12:13Z\",\n      \"updatedAt\": \"2025-11-19T10:12:13Z\"\n    }\n  ],\n  \"campaignAttachments\": [\n    {\n      \"attachmentId\": \"663\",\n      \"name\": \"Screenshot 2025-09-30 at 17.25.48.png\",\n      \"description\": \"proof of ownership\"\n    }\n  ],\n  \"logs\": [\n    {\n      \"previousStatus\": \"DRAFT\",\n      \"currentStatus\": \"PENDING_REVIEW\",\n      \"createdAt\": \"2025-11-19T10:12:13Z\"\n    },\n    {\n      \"previousStatus\": \"PENDING_REVIEW\",\n      \"currentStatus\": \"REVIEWING\",\n      \"createdAt\": \"2025-11-19T10:21:42Z\"\n    },\n    {\n      \"previousStatus\": \"REVIEWING\",\n      \"currentStatus\": \"AWAITING_CLIENT_UPDATE\",\n      \"createdAt\": \"2025-11-19T10:21:47Z\"\n    }\n  ],\n  \"notes\": [\n    {\n      \"author\": \"CUSTOMER\",\n      \"text\": \"My added note 1\",\n      \"createdAt\": \"2025-11-19T10:12:13Z\"\n    },\n    {\n      \"author\": \"CUSTOMER\",\n      \"text\": \"My added note 2\",\n      \"createdAt\": \"2025-11-19T10:12:13Z\"\n    }\n  ],\n  \"createdAt\": \"2025-11-19T10:12:12Z\",\n  \"updatedAt\": \"2025-11-19T10:22:00Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callback-event-reception","__idx":6},"children":["Callback event reception"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a callback URL was specified in the CreateAndSubmit or Update Request endpoint, then callback events will be received once the campaign state changes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"receive-callback-for-status-campaign-update","__idx":7},"children":["Receive callback for Status Campaign update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a campaign is first submitted, it receives a PENDING_REVIEW status. Once it is picked up for the review process, its status will be updated to REVIEWING."," ","This REVIEWING status confirms that the campaign is now in process of internal review by our team. Once the review is complete and the status changes again (e.g., to COMPLETED or CANCELLED), a callback notification will be sent to the callback_url you provided."," ","Please, read carefully the callback configuration API documentation to see how to authenticate this event."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eventId\": \"01k7m7aj4z127xs47rby8csbe6\",\n  \"resourceId\": \"8567\",\n  \"projectId\": \"27eb83b8-6030-491b-a3f5-2fc4b92a3aee\",\n  \"resourceType\": \"CAMPAIGN\",\n  \"eventType\": \"CAMPAIGN_STATUS_UPDATE\",\n  \"createTime\": \"2025-10-15T15:20:24Z\",\n  \"campaignStatus\": {\n    \"campaignId\": \"8567\",\n    \"newStatus\": \"REVIEWING\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"receive-callback-for-status-carrier-order-update","__idx":8},"children":["Receive callback for Status Carrier Order Update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A similar message is sent to update the carrier order status."," ","When a campaign is first submitted, it receives a SUBMITTED status."," ","A callback notification is sent to the provided callback_url."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eventId\": \"01k82z9pw57pscp4eber3d5vmg\",\n  \"resourceId\": \"69962\",\n  \"projectId\": \"27eb83b8-6030-491b-a3f5-2fc4b92a3aee\",\n  \"resourceType\": \"CARRIER_ORDER\",\n  \"eventType\": \"CARRIER_ORDER_STATUS_UPDATE\",\n  \"createTime\": \"2025-10-21T08:48:44Z\",\n  \"carrierOrderStatus\": {\n    \"campaignId\": \"8633\",\n    \"carrierOrderId\": \"69962\",\n    \"newStatus\": \"APPROVED\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"receive-callback-for-create-campaign-note","__idx":9},"children":["Receive callback for Create Campaign Note"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You will receive a callback notification at your provided callback_url when a reviewer adds a note to a submitted campaign."," ","Please, read carefully the callback configuration API documentation to see how to authenticate this event."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eventId\": \"01k815m2n680rknjwgsf1nt000\",\n  \"resourceId\": \"8624\",\n  \"projectId\": \"27eb83b8-6030-491b-a3f5-2fc4b92a3aee\",\n  \"resourceType\": \"CAMPAIGN\",\n  \"eventType\": \"CAMPAIGN_NOTE\",\n  \"createTime\": \"2025-10-20T16:00:46Z\",\n  \"campaignNote\": {\n    \"campaignId\": \"8624\",\n    \"note\": {\n      \"author\": \"AGENT\",\n      \"text\": \"Test Note Public\",\n      \"createdAt\": \"2025-10-20T16:00:46Z\"\n    }\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"receive-callback-for-create-carrier-order-note","__idx":10},"children":["Receive callback for Create Carrier Order Note"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A similar message is sent when a Note is created for Carrier Order."," ","You will receive a callback notification at your provided callback_url when a reviewer adds a note to a submitted carrier order."," ","Please, read carefully the callback configuration API documentation to see how to authenticate this event."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eventId\": \"01k831skbapcvh4mf9ffrp071h\",\n  \"resourceId\": \"69962\",\n  \"projectId\": \"27eb83b8-6030-491b-a3f5-2fc4b92a3aee\",\n  \"resourceType\": \"CARRIER_ORDER\",\n  \"eventType\": \"CARRIER_ORDER_NOTE\",\n  \"createTime\": \"2025-10-21T09:32:22Z\",\n  \"carrierOrderNote\": {\n    \"campaignId\": \"8633\",\n    \"carrierOrderId\": \"69962\",\n    \"note\": {\n      \"author\": \"AGENT\",\n      \"text\": \"Test Carrier Order note\",\n      \"createdAt\": \"2025-10-21T09:32:22Z\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Getting started with registering a campaign","id":"getting-started-with-registering-a-campaign","depth":1},{"value":"Authentication","id":"authentication","depth":2},{"value":"CreateAndSubmit Campaign","id":"createandsubmit-campaign","depth":2},{"value":"Upload an attachment","id":"upload-an-attachment","depth":2},{"value":"Request Client Certification","id":"request-client-certification","depth":2},{"value":"Update Campaign","id":"update-campaign","depth":2},{"value":"Callback event reception","id":"callback-event-reception","depth":2},{"value":"Receive callback for Status Campaign update","id":"receive-callback-for-status-campaign-update","depth":3},{"value":"Receive callback for Status Carrier Order Update","id":"receive-callback-for-status-carrier-order-update","depth":3},{"value":"Receive callback for Create Campaign Note","id":"receive-callback-for-create-campaign-note","depth":3},{"value":"Receive callback for Create Carrier Order Note","id":"receive-callback-for-create-carrier-order-note","depth":3}],"frontmatter":{"seo":{"title":"Register a new campaign","description":"Learn how to register a new campaign."},"excludeFromSearch":true},"lastModified":"2025-11-19T15:57:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/campaigns/getting-started/register-campaign","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}