# Sudonum API ## API Docs - Root > v2 > audiofiles [Get a list of your uploaded audio files (MP3)](https://apidog.docs.sudonum.com/get-a-list-of-your-uploaded-audio-files-mp3-42645328e0.md): - Root > v2 > audiofiles [Upload an audio file](https://apidog.docs.sudonum.com/upload-an-audio-file-42645329e0.md): - Root > v2 > audiofiles [Delete an uploaded MP3 audio file](https://apidog.docs.sudonum.com/delete-an-uploaded-mp3-audio-file-42645330e0.md): - Root > v2 > logs [Get your billable number logs](https://apidog.docs.sudonum.com/get-your-billable-number-logs-42645331e0.md): Get the logs for your billable numbers. If no parameters are passed in, all billing class records for the last billing month are returned. - Root > v2 > logs [Get your raw number logs](https://apidog.docs.sudonum.com/get-your-raw-number-logs-42645332e0.md): Get the logs for actions on numbers, such as creation or deletion of numbers, or any updates made to your numbers. - Root > v2 > logs [Get your voice-call logs](https://apidog.docs.sudonum.com/get-your-voice-call-logs-42645333e0.md): If no parameters are passed in, all log records for the current month are returned. If you pass in a date, you need to pass in both an end_date and start_date. Maximum date window is 60 days. - Root > v2 > number > search [Search for Sudonum](https://apidog.docs.sudonum.com/search-for-sudonum-42645336e0.md): ### Request - Root > v2 > number > bulk [Update Sudonums in bulk](https://apidog.docs.sudonum.com/update-sudonums-in-bulk-42645337e0.md): A maximum of 200 Sudonums can be updated at once. - Root > v2 > number > bulk [Create Sudonums in bulk](https://apidog.docs.sudonum.com/create-sudonums-in-bulk-42645338e0.md): A maximum of 2 Sudonums can be created at once. - Root > v2 > number > bulk [Partial update Sudonums in bulk](https://apidog.docs.sudonum.com/partial-update-sudonums-in-bulk-42645339e0.md): A maximum of 200 Sudonums can be updated at once. - Root > v2 > number > {number} [Return the details for a Sudonum](https://apidog.docs.sudonum.com/return-the-details-for-a-sudonum-42645340e0.md): Return all associated data for a Sudonum. - Root > v2 > number > {number} [Update a Sudonum](https://apidog.docs.sudonum.com/update-a-sudonum-42645341e0.md): Update associated data on a Sudonum. - Root > v2 > number > {number} [Delete a Sudonum](https://apidog.docs.sudonum.com/delete-a-sudonum-42645342e0.md): Delete a Sudonum and all associated data. Call detail records will not be affected. - Root > v2 > number > {number} [Partial update a Sudonum](https://apidog.docs.sudonum.com/partial-update-a-sudonum-42645343e0.md): Partially update associated data on a Sudonum. - Root > v2 > number [Return all active Sudonum numbers](https://apidog.docs.sudonum.com/return-all-active-sudonum-numbers-42645334e0.md): Return a JSON list of all active Sudonum numbers, their target numbers and associated data. - Root > v2 > number [Buy a number](https://apidog.docs.sudonum.com/buy-a-number-42645335e0.md): Link a Sudonum with certain capabilities to your account. The target_number parameter is required for most, but not all, features. - Root > v2 > send-sms [Send an SMS](https://apidog.docs.sudonum.com/send-an-sms-42645344e0.md): Send an SMS from a SMS capable Sudonum to a South African mobile number. - Root > v2 > send-sms [Send multiple SMSes.](https://apidog.docs.sudonum.com/send-multiple-smses-42645345e0.md): Send SMSes from a SMS capable Sudonum to multiple South African mobile numbers. - Root > v2 > status [Get the current status of the SMS Network](https://apidog.docs.sudonum.com/get-the-current-status-of-the-sms-network-42645346e0.md): - Root > v2 > status [Get the current status of the Voice Network](https://apidog.docs.sudonum.com/get-the-current-status-of-the-voice-network-42645347e0.md): - Root > v2 > webhooks > {name} [Return the details for a webhook](https://apidog.docs.sudonum.com/return-the-details-for-a-webhook-42645350e0.md): - Root > v2 > webhooks > {name} [Update a webhook](https://apidog.docs.sudonum.com/update-a-webhook-42645351e0.md): - Root > v2 > webhooks > {name} [Delete a webhook](https://apidog.docs.sudonum.com/delete-a-webhook-42645352e0.md): - Root > v2 > webhooks > {name} [Partially update a webhook](https://apidog.docs.sudonum.com/partially-update-a-webhook-42645353e0.md): - Root > v2 > webhooks [Get a list of your webhooks](https://apidog.docs.sudonum.com/get-a-list-of-your-webhooks-42645348e0.md): - Root > v2 > webhooks [Create a webhook](https://apidog.docs.sudonum.com/create-a-webhook-42645349e0.md): - Root > v2 > Whatsapp > accounts [WhatsApp Accounts](https://apidog.docs.sudonum.com/whatsapp-accounts-42645355e0.md): This returns a paginated list of all the WhatsApp Accounts. - Root > v2 > Whatsapp > accounts [Single WhatsApp Account](https://apidog.docs.sudonum.com/single-whatsapp-account-42645356e0.md): This returns the details of a single WhatsApp Account. - Root > v2 > Whatsapp > chat-intro-logs > {chat intro log uuid}/status-logs [All status change logs for a Chat Intro Log](https://apidog.docs.sudonum.com/all-status-change-logs-for-a-chat-intro-log-42645359e0.md): This returns a paginated list of all the status change logs of a - Root > v2 > Whatsapp > chat-intro-logs > {chat intro log uuid}/status-logs [Status change log for a Chat Intro Log](https://apidog.docs.sudonum.com/status-change-log-for-a-chat-intro-log-42645360e0.md): This returns the details of a single status change log of a specific - Root > v2 > Whatsapp > chat-intro-logs [All Chat Intro Logs](https://apidog.docs.sudonum.com/all-chat-intro-logs-42645357e0.md): This returns a paginated list of all the WhatsApp Chat Intro Logs - Root > v2 > Whatsapp > chat-intro-logs [Single Chat Intro Log](https://apidog.docs.sudonum.com/single-chat-intro-log-42645358e0.md): This returns the details of a single WhatsApp Chat Intro Log. - Root > v2 > Whatsapp > chat-intros > {uuid} [Single Chat Intro](https://apidog.docs.sudonum.com/single-chat-intro-42645365e0.md): This returns the details of a single WhatsApp Chat Intro. - Root > v2 > Whatsapp > chat-intros > {uuid} [Update Chat Intro](https://apidog.docs.sudonum.com/update-chat-intro-42645366e0.md): Use this to update every detail of a previously created WhatsApp - Root > v2 > Whatsapp > chat-intros > {uuid} [Delete Chat Intro](https://apidog.docs.sudonum.com/delete-chat-intro-42645367e0.md): Use this to delete a specific WhatsApp Chat Intro on a WhatsApp - Root > v2 > Whatsapp > chat-intros > {uuid} [Partially update Chat Intro](https://apidog.docs.sudonum.com/partially-update-chat-intro-42645368e0.md): Use this to update only specific details of a previously created - Root > v2 > Whatsapp > chat-intros > {uuid} [Partially update Chat Intro (application/json)](https://apidog.docs.sudonum.com/partially-update-chat-intro-applicationjson-42645369e0.md): Use this to update only specific details of a previously created - Root > v2 > Whatsapp > chat-intros > reply components [Interactive Flow Reply](https://apidog.docs.sudonum.com/interactive-flow-reply-42645370e0.md): - Root > v2 > Whatsapp > chat-intros > reply components [Text Reply (Default)](https://apidog.docs.sudonum.com/text-reply-default-42645371e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > reply components [Image Reply](https://apidog.docs.sudonum.com/image-reply-42645372e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > reply components [Interactive Reply CTA](https://apidog.docs.sudonum.com/interactive-reply-cta-42645373e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > reply components [Interactive List Reply](https://apidog.docs.sudonum.com/interactive-list-reply-42645374e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > reply components [Interactive Quick Reply](https://apidog.docs.sudonum.com/interactive-quick-reply-42645375e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > alternative reply components [Text Reply](https://apidog.docs.sudonum.com/text-reply-42645376e0.md): - Root > v2 > Whatsapp > chat-intros > alternative reply components [Image Reply](https://apidog.docs.sudonum.com/image-reply-42645377e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > alternative reply components [Interactive Quick Reply](https://apidog.docs.sudonum.com/interactive-quick-reply-42645378e0.md): **Create a chatintro** - Root > v2 > Whatsapp > chat-intros > aparty connect [Interactive CTA Reply](https://apidog.docs.sudonum.com/interactive-cta-reply-42645379e0.md): **Allow APARTY to directly connect with a click out to the BPARTY** - Root > v2 > Whatsapp > chat-intros > aparty connect [Aparty Template](https://apidog.docs.sudonum.com/aparty-template-42645380e0.md): **Allow APARTY to directly connect with a click out to the BPARTY** - Root > v2 > Whatsapp > chat-intros > aparty connect [Text Reply](https://apidog.docs.sudonum.com/text-reply-42645381e0.md): **Allow APARTY to directly connect with a click out to the BPARTY** - Root > v2 > Whatsapp > chat-intros > aparty components [Aparty notify Flow template](https://apidog.docs.sudonum.com/aparty-notify-flow-template-42645382e0.md): - Root > v2 > Whatsapp > chat-intros > aparty components [Aparty Template Components](https://apidog.docs.sudonum.com/aparty-template-components-42645383e0.md): **Allow APARTY to directly connect with a click out to the BPARTY** - Root > v2 > Whatsapp > chat-intros > aparty components [Aparty Template Components + Aparty connect](https://apidog.docs.sudonum.com/aparty-template-components-aparty-connect-42645384e0.md): **Allow APARTY to directly connect with a click out to the BPARTY** - Root > v2 > Whatsapp > chat-intros [Create a chat intro.](https://apidog.docs.sudonum.com/create-a-chat-intro-42645361e0.md): Creates one chat intro on the WhatsApp number you name in `whatsapp_number`. The number must belong to your organisation. - Root > v2 > Whatsapp > chat-intros [All Chat Intros](https://apidog.docs.sudonum.com/all-chat-intros-42645362e0.md): This returns a paginated list of all the WhatsApp Chat Intros on each - Root > v2 > Whatsapp > chat-intros [Create Chat Intro](https://apidog.docs.sudonum.com/create-chat-intro-42645363e0.md): This allows you to successfully attribute WhatsApp leads to a specific - Root > v2 > Whatsapp > chat-intros [Chat Intro Logs for a Chat Intro](https://apidog.docs.sudonum.com/chat-intro-logs-for-a-chat-intro-42645364e0.md): This returns a paginated list of all the WhatsApp Chat Intro Logs - Root > v2 > Whatsapp > message-templates [All WhatsApp Message Templates](https://apidog.docs.sudonum.com/all-whatsapp-message-templates-42645385e0.md): This returns a paginated list of all the WhatsApp Message Templates - Root > v2 > Whatsapp > message-templates [WhatsApp Message Template](https://apidog.docs.sudonum.com/whatsapp-message-template-42645386e0.md): This returns the details of a single WhatsApp Message Template. - Root > v2 > Whatsapp > messages > {uuid} [Single WhatsApp Message](https://apidog.docs.sudonum.com/single-whatsapp-message-42645394e0.md): This returns the details of a single WhatsApp Message. - Root > v2 > Whatsapp > messages > interactive messages [Interactive Flow Message - flow_id](https://apidog.docs.sudonum.com/interactive-flow-message-flow-id-42645395e0.md): - Root > v2 > Whatsapp > messages > interactive messages [Interactive Flow Message - flow_name](https://apidog.docs.sudonum.com/interactive-flow-message-flow-name-42645396e0.md): - Root > v2 > Whatsapp > messages > interactive messages [Send Interactive List Message](https://apidog.docs.sudonum.com/send-interactive-list-message-42645397e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > interactive messages [Send Interactive Quick Reply Message](https://apidog.docs.sudonum.com/send-interactive-quick-reply-message-42645398e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > interactive messages [Send Interactive Quick Reply Message + Media Header](https://apidog.docs.sudonum.com/send-interactive-quick-reply-message-media-header-42645399e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > interactive messages [Send Interactive Call-To-Action Message](https://apidog.docs.sudonum.com/send-interactive-call-to-action-message-42645400e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > interactive messages [Send Interactive Location Request Message](https://apidog.docs.sudonum.com/send-interactive-location-request-message-42645401e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Flow Template (custom token)](https://apidog.docs.sudonum.com/send-flow-template-custom-token-42645402e0.md): - Root > v2 > Whatsapp > messages > templates messages [Send Flow Template (no params)](https://apidog.docs.sudonum.com/send-flow-template-no-params-42645403e0.md): - Root > v2 > Whatsapp > messages > templates messages [Send Message](https://apidog.docs.sudonum.com/send-message-42645404e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (no body)](https://apidog.docs.sudonum.com/send-template-no-body-42645405e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (body + url button)](https://apidog.docs.sudonum.com/send-template-body-url-button-42645406e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (header IMAGE + body)](https://apidog.docs.sudonum.com/send-template-header-image-body-42645407e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (header VIDEO + body)](https://apidog.docs.sudonum.com/send-template-header-video-body-42645408e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (header TEXT + body)](https://apidog.docs.sudonum.com/send-template-header-text-body-42645409e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (header LOCATION + body + button)](https://apidog.docs.sudonum.com/send-template-header-location-body-button-42645410e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Template (Quick Reply with payload )](https://apidog.docs.sudonum.com/send-template-quick-reply-with-payload-42645411e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send LTO Coupon Template (no expiry date)](https://apidog.docs.sudonum.com/send-lto-coupon-template-no-expiry-date-42645412e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send LTO Coupon (WITH expiry date)](https://apidog.docs.sudonum.com/send-lto-coupon-with-expiry-date-42645413e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Carousel Message Template](https://apidog.docs.sudonum.com/send-carousel-message-template-42645414e0.md): This allows you to send a Carousel Media Message Template from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send OTP Template](https://apidog.docs.sudonum.com/send-otp-template-42645415e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages > templates messages [Send Coupon Template](https://apidog.docs.sudonum.com/send-coupon-template-42645416e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages [All Messages](https://apidog.docs.sudonum.com/all-messages-42645387e0.md): Returns one page of messages, newest first, scoped to the caller's org. - Root > v2 > Whatsapp > messages [All Messages from Campaign Log](https://apidog.docs.sudonum.com/all-messages-from-campaign-log-42645388e0.md): This returns a paginated list of all the WhatsApp Messages sent from or sent to each of your WhatsApp numbers. - Root > v2 > Whatsapp > messages [Send Contact](https://apidog.docs.sudonum.com/send-contact-42645389e0.md): This allows you to send a Contact Message from your WhatsApp number. - Root > v2 > Whatsapp > messages [Send Text Message](https://apidog.docs.sudonum.com/send-text-message-42645390e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages [Send Media Message](https://apidog.docs.sudonum.com/send-media-message-42645391e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages [Send Location Message](https://apidog.docs.sudonum.com/send-location-message-42645392e0.md): This allows you to send a WhatsApp Message from your WhatsApp number. - Root > v2 > Whatsapp > messages [Send Reaction Message](https://apidog.docs.sudonum.com/send-reaction-message-42645393e0.md): This allows you to send a reaction emoji to an existing message from your WhatsApp number. - Root > v2 > Whatsapp > webhooks > {uuid} [Single WhatsApp Webhook](https://apidog.docs.sudonum.com/single-whatsapp-webhook-42645419e0.md): This returns the details of a single WhatsApp Webhook. - Root > v2 > Whatsapp > webhooks > {uuid} [Update a Webhook](https://apidog.docs.sudonum.com/update-a-webhook-42645420e0.md): Use this to update every detail of a previously created WhatsApp - Root > v2 > Whatsapp > webhooks > {uuid} [Delete a Webhook](https://apidog.docs.sudonum.com/delete-a-webhook-42645421e0.md): Use this to delete a specific WhatsApp Webhook on a WhatsApp number. - Root > v2 > Whatsapp > webhooks > {uuid} [Partially update Webhook](https://apidog.docs.sudonum.com/partially-update-webhook-42645422e0.md): Use this to update only specific details of a previously created - Root > v2 > Whatsapp > webhooks [All Webhooks](https://apidog.docs.sudonum.com/all-webhooks-42645417e0.md): This returns a paginated list of all the WhatsApp Webhooks on each of - Root > v2 > Whatsapp > webhooks [Create Webhook](https://apidog.docs.sudonum.com/create-webhook-42645418e0.md): This allows you to receive updates on all the activity happening on - Root > v2 > Whatsapp > template media [Upload Whatsapp Media](https://apidog.docs.sudonum.com/upload-whatsapp-media-42645423e0.md): - Root > v2 > Whatsapp > template media [All Whatsapp Media](https://apidog.docs.sudonum.com/all-whatsapp-media-42645424e0.md): This returns a paginated list of all the WhatsApp Messages sent from - Root > v2 > Whatsapp > Flows > {uuid} [Retrieve a single flow.](https://apidog.docs.sudonum.com/retrieve-a-single-flow-42645427e0.md): Requires the `whatsapp.view_flow` permission. - Root > v2 > Whatsapp > Flows > {uuid} [Update a flow's name, status or category.](https://apidog.docs.sudonum.com/update-a-flows-name-status-or-category-42645428e0.md): Partial update. Any subset of the writable fields may be sent; anything omitted is left as it is, and any field outside the writable set (`flow_identifier`, `data`, `uuid`, ...) is ignored rather than rejected. - Root > v2 > Whatsapp > Flows > {uuid} [Not supported.](https://apidog.docs.sudonum.com/not-supported-42645429e0.md): Flows are removed on Meta, not here. Always 405. - Root > v2 > Whatsapp > Flows > {uuid} [Fetch Meta's preview URL for a flow.](https://apidog.docs.sudonum.com/fetch-metas-preview-url-for-a-flow-42645430e0.md): Asks Meta for a web preview of the flow and returns the URL it hands back. The URL is short-lived and issued per request -- fetch it when you are about to open the preview rather than caching it. - Root > v2 > Whatsapp > Flows [List the flows on your organisation's WABAs.](https://apidog.docs.sudonum.com/list-the-flows-on-your-organisations-wabas-42645425e0.md): Returns every flow whose WABA profile belongs to the calling organisation. Flows on another org's WABA, or on a WABA profile with no org assigned, are never listed. - Root > v2 > Whatsapp > Flows [Not supported.](https://apidog.docs.sudonum.com/not-supported-42645426e0.md): Flows are authored on Meta and mirrored in; they are not created over this API. Always 405. - Root > v2 > Whatsapp > Leads [Submit WhatsApp number.](https://apidog.docs.sudonum.com/submit-whatsapp-number-42645431e0.md): Accepts one lead and queues it for processing. - Root > v2 > Whatsapp > Leads [List the leads submitted against a WhatsApp number.](https://apidog.docs.sudonum.com/list-the-leads-submitted-against-a-whatsapp-number-42645432e0.md): Returns the leads submitted against this WhatsApp number, newest first, in pages. Every filter is optional, and filters combine with AND. - Root > v2 > Whatsapp [Start a chat intro](https://apidog.docs.sudonum.com/start-a-chat-intro-42645354e0.md): Initiate a Chat Intro by providing the `reference_id` and enquirer's details. - Root > v2 > Campaigns > Campaigns > :uuid [Single Campaign](https://apidog.docs.sudonum.com/single-campaign-42645435e0.md): Returns a single campaign object. - Root > v2 > Campaigns > Campaigns > :uuid [Replace Campaign](https://apidog.docs.sudonum.com/replace-campaign-42645436e0.md): Replaces every writable field on a campaign. Fields you omit keep their current value; they are not cleared. - Root > v2 > Campaigns > Campaigns > :uuid [Update Campaign](https://apidog.docs.sudonum.com/update-campaign-42645437e0.md): Updates a campaign. Only the fields you send are changed. - Root > v2 > Campaigns > Campaigns > :uuid [Delete Campaign](https://apidog.docs.sudonum.com/delete-campaign-42645438e0.md): Deletes a campaign. - Root > v2 > Campaigns > Campaigns > :uuid [Sample CSV for Campaign](https://apidog.docs.sudonum.com/sample-csv-for-campaign-42645439e0.md): ### Prerequisites - Root > v2 > Campaigns > Campaigns > :uuid [Upload Contacts to Campaign](https://apidog.docs.sudonum.com/upload-contacts-to-campaign-42645440e0.md): ### Prerequisites - Root > v2 > Campaigns > Campaigns [List of Campaigns](https://apidog.docs.sudonum.com/list-of-campaigns-42645433e0.md): Returns a paginated list of all campaigns for your organisation. - Root > v2 > Campaigns > Campaigns [Create Campaign](https://apidog.docs.sudonum.com/create-campaign-42645434e0.md): Creates a campaign object. - Root > v2 > Campaigns > Campaign Logs > :uuid [Single Campaign Log](https://apidog.docs.sudonum.com/single-campaign-log-42645444e0.md): Returns a single campaign log object. - Root > v2 > Campaigns > Campaign Logs > :uuid [Replace Campaign Log](https://apidog.docs.sudonum.com/replace-campaign-log-42645445e0.md): Replaces every writable field on a campaign log. Fields you omit keep their current value; they are not cleared. - Root > v2 > Campaigns > Campaign Logs > :uuid [Update Campaign Log](https://apidog.docs.sudonum.com/update-campaign-log-42645446e0.md): Updates a campaign log. Only the fields you send are changed. - Root > v2 > Campaigns > Campaign Logs > :uuid [Delete Campaign Log](https://apidog.docs.sudonum.com/delete-campaign-log-42645447e0.md): Deletes a campaign log. - Root > v2 > Campaigns > Campaign Logs > :uuid [Opted-out Contacts](https://apidog.docs.sudonum.com/opted-out-contacts-42645448e0.md): Returns a paginated list of the contacts that have opted out of your campaign. - Root > v2 > Campaigns > Campaign Logs [List of Campaign Logs](https://apidog.docs.sudonum.com/list-of-campaign-logs-42645441e0.md): Returns a paginated list of all campaign logs for your organisation. - Root > v2 > Campaigns > Campaign Logs [Create Campaign Log](https://apidog.docs.sudonum.com/create-campaign-log-42645442e0.md): Creates a campaign log object. - Root > v2 > Campaigns > Campaign Logs [Export Campaign Logs](https://apidog.docs.sudonum.com/export-campaign-logs-42645443e0.md): Queues a CSV export of campaign logs and returns a job `uuid` with a download URL to poll. - Root > v2 > Campaigns > Contacts > :uuid [Single Contact](https://apidog.docs.sudonum.com/single-contact-42645454e0.md): Returns a single contact object. - Root > v2 > Campaigns > Contacts > :uuid [Replace Contact](https://apidog.docs.sudonum.com/replace-contact-42645455e0.md): Replaces every writable field on a contact. Fields you omit keep their current value; they are not cleared. - Root > v2 > Campaigns > Contacts > :uuid [Update Contact](https://apidog.docs.sudonum.com/update-contact-42645456e0.md): Updates a contact. Only the fields you send are changed. - Root > v2 > Campaigns > Contacts > :uuid [Delete Contact](https://apidog.docs.sudonum.com/delete-contact-42645457e0.md): Deletes a contact. - Root > v2 > Campaigns > Contacts [List of Contacts](https://apidog.docs.sudonum.com/list-of-contacts-42645449e0.md): Returns a paginated list of all contacts for your organisation. - Root > v2 > Campaigns > Contacts [Create Contact](https://apidog.docs.sudonum.com/create-contact-42645450e0.md): Creates a contact object. - Root > v2 > Campaigns > Contacts [Download Contact CSV Sample File](https://apidog.docs.sudonum.com/download-contact-csv-sample-file-42645451e0.md): Returns a blank CSV with the contact columns (`first_name`, `last_name`, - Root > v2 > Campaigns > Contacts [Upload Contact CSV](https://apidog.docs.sudonum.com/upload-contact-csv-42645452e0.md): Uploads a populated contact CSV (see **Download Contact CSV Sample File**) - Root > v2 > Campaigns > Contacts [Download Contact CSV sample file](https://apidog.docs.sudonum.com/download-contact-csv-sample-file-42645453e0.md): This returns a csv file, that can be use to populate contact details in. - Root > v2 > Campaigns > Lists > :uuid [Single Campaign List](https://apidog.docs.sudonum.com/single-campaign-list-42645460e0.md): Returns a single campaign list object. - Root > v2 > Campaigns > Lists > :uuid [Replace Campaign List](https://apidog.docs.sudonum.com/replace-campaign-list-42645461e0.md): Replaces every writable field on a campaign list. Fields you omit keep their current value; they are not cleared. - Root > v2 > Campaigns > Lists > :uuid [Update Campaign List](https://apidog.docs.sudonum.com/update-campaign-list-42645462e0.md): Updates a campaign list. Only the fields you send are changed. - Root > v2 > Campaigns > Lists > :uuid [Delete Campaign List](https://apidog.docs.sudonum.com/delete-campaign-list-42645463e0.md): Deletes a campaign list. - Root > v2 > Campaigns > Lists > :uuid [List Contacts under Campaign List](https://apidog.docs.sudonum.com/list-contacts-under-campaign-list-42645464e0.md): Returns a paginated list of the contacts that belong to this campaign list. - Root > v2 > Campaigns > Lists > :uuid [Export Contacts under Campaign List](https://apidog.docs.sudonum.com/export-contacts-under-campaign-list-42645465e0.md): Queues a CSV export of this campaign list's contacts and returns a job - Root > v2 > Campaigns > Lists [List of Campaign Lists](https://apidog.docs.sudonum.com/list-of-campaign-lists-42645458e0.md): Returns a paginated list of all campaign lists for your organisation. - Root > v2 > Campaigns > Lists [Create Campaign List](https://apidog.docs.sudonum.com/create-campaign-list-42645459e0.md): Creates a campaign list object. - Root > v2 > Campaigns > Opt-outs > :uuid [Single Opt-out](https://apidog.docs.sudonum.com/single-opt-out-42645469e0.md): Returns a single opt-out object. - Root > v2 > Campaigns > Opt-outs > :uuid [Replace Opt-out](https://apidog.docs.sudonum.com/replace-opt-out-42645470e0.md): Replaces every writable field on an opt-out. Fields you omit keep their current value; they are not cleared. - Root > v2 > Campaigns > Opt-outs > :uuid [Update Opt-out](https://apidog.docs.sudonum.com/update-opt-out-42645471e0.md): Updates an opt-out record. Only the fields you send are changed -- so this is also how a contact is opted back in: set the relevant `opted_out_*` flag to `false`. - Root > v2 > Campaigns > Opt-outs > :uuid [Single Opt-out/Opt-in Event](https://apidog.docs.sudonum.com/single-opt-outopt-in-event-42645472e0.md): Returns a single opt-out/opt-in event object. - Root > v2 > Campaigns > Opt-outs [List of Opt-outs](https://apidog.docs.sudonum.com/list-of-opt-outs-42645466e0.md): Returns a paginated list of contacts that have opted out. - Root > v2 > Campaigns > Opt-outs [Create Opt-out](https://apidog.docs.sudonum.com/create-opt-out-42645467e0.md): Creates an opt-out record for a contact. `categories` is required: send an empty list to opt the contact out of everything (a global opt-out), or one or more categories to opt them out of just those. `sender_whatsapp_number` is required too, since an opt-out always names one sending number. `origin` is recorded as `API` automatically. - Root > v2 > Campaigns > Opt-outs [List of Opt-out/Opt-in Events](https://apidog.docs.sudonum.com/list-of-opt-outopt-in-events-42645468e0.md): Returns a paginated list of all opt-out/opt-in events for your organisation. - Root > v2 > Sumi Insights Config > /{uuid} [Edit Sumi Config](https://apidog.docs.sudonum.com/edit-sumi-config-42645475e0.md): - Root > v2 > Sumi Insights Config > /{uuid} [Get Sumi Config](https://apidog.docs.sudonum.com/get-sumi-config-42645476e0.md): - Root > v2 > Sumi Insights Config [Get Sumi Configs](https://apidog.docs.sudonum.com/get-sumi-configs-42645473e0.md): - Root > v2 > Sumi Insights Config [Create Sumi Config](https://apidog.docs.sudonum.com/create-sumi-config-42645474e0.md): - Root > v2 > Sumi Agent Config > {uuid} [Config](https://apidog.docs.sudonum.com/config-42645478e0.md): - Root > v2 > Sumi Agent Config [All Configs](https://apidog.docs.sudonum.com/all-configs-42645477e0.md): - Root > v2 > RoutingConfigs [List RoutingConfigs](https://apidog.docs.sudonum.com/list-routingconfigs-42645479e0.md): Returns the routing configs of your organisation, newest first. The response is paginated. - Root > v2 > RoutingConfigs [Create a RoutingConfig](https://apidog.docs.sudonum.com/create-a-routingconfig-42645480e0.md): Creates one routing config on your organisation. - Root > v2 > RoutingConfigs [Retrieve a RoutingConfig](https://apidog.docs.sudonum.com/retrieve-a-routingconfig-42645481e0.md): Returns one routing config. A config on another organisation returns a 404. - Root > v2 > RoutingConfigs [Replace a RoutingConfig](https://apidog.docs.sudonum.com/replace-a-routingconfig-42645482e0.md): Updates the routing config, with `name` required. - Root > v2 > RoutingConfigs [Update a RoutingConfig](https://apidog.docs.sudonum.com/update-a-routingconfig-42645483e0.md): Updates only the fields you send. Every other field keeps its stored value. - Root > v2 > RoutingConfigs [Delete a RoutingConfig](https://apidog.docs.sudonum.com/delete-a-routingconfig-42645484e0.md): Deletes the routing config. - Root > v2 [Get an authentication token](https://apidog.docs.sudonum.com/get-an-authentication-token-42645319e0.md): You will need this authentication token to use the API. - Root > v2 [Number prefixes available on your account](https://apidog.docs.sudonum.com/number-prefixes-available-on-your-account-42645320e0.md): Enter a valid [country code](https://en.wikipedia.org/wiki/List_of_country_calling_codes) to get a list of available locations in a country. - Root > v2 [Call detail records](https://apidog.docs.sudonum.com/call-detail-records-42645321e0.md): - Root > v2 [Number capabilities](https://apidog.docs.sudonum.com/number-capabilities-42645322e0.md): Get a list of valid parameters for the capabilities field. The 'name' field is the value to be passed into the capabilities field for the number endpoint. - Root > v2 [Voice feature list](https://apidog.docs.sudonum.com/voice-feature-list-42645323e0.md): Get a list of valid parameters for the features field. The 'name' field is the value to be passed into the features field for the number endpoint. - Root > v2 [Number insights](https://apidog.docs.sudonum.com/number-insights-42645324e0.md): Get insights on a number, e.g. type and region. Enter the number in +E164 format (e.g. +27825574324). Mobile network info is only returned for mobile numbers. - Root > v2 [SMS records](https://apidog.docs.sudonum.com/sms-records-42645325e0.md): - Root > v2 [Start a call](https://apidog.docs.sudonum.com/start-a-call-42645326e0.md): - Root > v2 [Webhook types](https://apidog.docs.sudonum.com/webhook-types-42645327e0.md): The 'name' field is the value to be passed as the type to a webhook. - Root > v3 > sumi > jobs > {uuid} [Retrieve a job](https://apidog.docs.sudonum.com/retrieve-a-job-42645487e0.md): - Root > v3 > sumi > jobs [List Jobs](https://apidog.docs.sudonum.com/list-jobs-42645485e0.md): - Root > v3 > sumi > jobs [Submit a job](https://apidog.docs.sudonum.com/submit-a-job-42645486e0.md): ## Schemas - Root [JobSubmit](https://apidog.docs.sudonum.com/jobsubmit-17352070d0.md): - Root [FlowStatus](https://apidog.docs.sudonum.com/flowstatus-17352071d0.md): - Root [MessagePage](https://apidog.docs.sudonum.com/messagepage-17358259d0.md): - Root [Enquirer](https://apidog.docs.sudonum.com/enquirer-17352072d0.md): - Root [ChatIntroCreate](https://apidog.docs.sudonum.com/chatintrocreate-17352073d0.md): - Root [Destination](https://apidog.docs.sudonum.com/destination-17352074d0.md): - Root [BlankEnum](https://apidog.docs.sudonum.com/blankenum-17352075d0.md): - Root [CampaignCategoryEnum](https://apidog.docs.sudonum.com/campaigncategoryenum-17352076d0.md): - Root [JobCreated](https://apidog.docs.sudonum.com/jobcreated-17352077d0.md): - Root [FlowCategory](https://apidog.docs.sudonum.com/flowcategory-17352078d0.md): - Root [Listing](https://apidog.docs.sudonum.com/listing-17352079d0.md): - Root [ReplyAlt](https://apidog.docs.sudonum.com/replyalt-17352080d0.md): - Root [TimeOfDay](https://apidog.docs.sudonum.com/timeofday-17352081d0.md): - Root [CreateOptOutContactLogRequest](https://apidog.docs.sudonum.com/createoptoutcontactlogrequest-17352082d0.md): - Root [CreateCampaign](https://apidog.docs.sudonum.com/createcampaign-17352083d0.md): - Root [Message](https://apidog.docs.sudonum.com/message-17358260d0.md): - Root [PatchedListOptOutListRequest](https://apidog.docs.sudonum.com/patchedlistoptoutlistrequest-17352084d0.md): - Root [OptOutEvent](https://apidog.docs.sudonum.com/optoutevent-17352085d0.md): - Root [ListOptOutListRequest](https://apidog.docs.sudonum.com/listoptoutlistrequest-17352086d0.md): - Root [CreateCampaignRequest](https://apidog.docs.sudonum.com/createcampaignrequest-17352087d0.md): - Root [PatchedUpdateCampaignRequest](https://apidog.docs.sudonum.com/patchedupdatecampaignrequest-17352088d0.md): - Root [UpdateCampaign](https://apidog.docs.sudonum.com/updatecampaign-17352089d0.md): - Root [UpdateCampaignRequest](https://apidog.docs.sudonum.com/updatecampaignrequest-17352090d0.md): - Root [ListCampaign](https://apidog.docs.sudonum.com/listcampaign-17352091d0.md): - Root [ListOptOutList](https://apidog.docs.sudonum.com/listoptoutlist-17352092d0.md): - Root [ChatIntro](https://apidog.docs.sudonum.com/chatintro-17352093d0.md): - Root [RouteConditions](https://apidog.docs.sudonum.com/routeconditions-17352094d0.md): - Root [Flow](https://apidog.docs.sudonum.com/flow-17352095d0.md): - Root [CampaignErrorResponse](https://apidog.docs.sudonum.com/campaignerrorresponse-17352096d0.md): - Root [JobList](https://apidog.docs.sudonum.com/joblist-17352097d0.md): - Root [LeadSubmit](https://apidog.docs.sudonum.com/leadsubmit-17352098d0.md): - Root [CampaignListContactUploadRequest](https://apidog.docs.sudonum.com/campaignlistcontactuploadrequest-17352099d0.md): - Root [FlowList](https://apidog.docs.sudonum.com/flowlist-17352100d0.md): - Root [MessageType](https://apidog.docs.sudonum.com/messagetype-17358261d0.md): - Root [LeadRecord](https://apidog.docs.sudonum.com/leadrecord-17352102d0.md): - Root [RouteFallback](https://apidog.docs.sudonum.com/routefallback-17352103d0.md): - Root [JobStatus](https://apidog.docs.sudonum.com/jobstatus-17352104d0.md): - Root [LeadPage](https://apidog.docs.sudonum.com/leadpage-17352105d0.md): - Root [CampaignLog](https://apidog.docs.sudonum.com/campaignlog-17352106d0.md): - Root [MessageDirection](https://apidog.docs.sudonum.com/messagedirection-17358262d0.md): - Root [DetailBody](https://apidog.docs.sudonum.com/detailbody-17352107d0.md): - Root [Route](https://apidog.docs.sudonum.com/route-17352108d0.md): - Root [FlowUpdate](https://apidog.docs.sudonum.com/flowupdate-17352109d0.md): - Root [JobDetail](https://apidog.docs.sudonum.com/jobdetail-17352110d0.md): - Root [TranscriptSegment](https://apidog.docs.sudonum.com/transcriptsegment-17352111d0.md): - Root [FlowPreview](https://apidog.docs.sudonum.com/flowpreview-17352112d0.md): - Root [MessageStatus](https://apidog.docs.sudonum.com/messagestatus-17358263d0.md): - Root [RoutingConfigWrite](https://apidog.docs.sudonum.com/routingconfigwrite-17352113d0.md): - Root [CampaignStatusEnum](https://apidog.docs.sudonum.com/campaignstatusenum-17352114d0.md): - Root [SumiInsights](https://apidog.docs.sudonum.com/sumiinsights-17352115d0.md): - Root [PreviewError](https://apidog.docs.sudonum.com/previewerror-17352116d0.md): - Root [RoutingConfigPatch](https://apidog.docs.sudonum.com/routingconfigpatch-17352117d0.md): - Root [CampaignUploadResponse](https://apidog.docs.sudonum.com/campaignuploadresponse-17352118d0.md): - Root [ErrorsBody](https://apidog.docs.sudonum.com/errorsbody-17352119d0.md): - Root [MomentMatches](https://apidog.docs.sudonum.com/momentmatches-17352120d0.md): - Root [Detail](https://apidog.docs.sudonum.com/detail-17358264d0.md): - Root [RoutingConfig](https://apidog.docs.sudonum.com/routingconfig-17352121d0.md): - Root [ChannelTypeEnum](https://apidog.docs.sudonum.com/channeltypeenum-17352122d0.md): - Root [Error](https://apidog.docs.sudonum.com/error-17352123d0.md): - Root [ContactUploadRequest](https://apidog.docs.sudonum.com/contactuploadrequest-17352124d0.md): - Root [ValidationError](https://apidog.docs.sudonum.com/validationerror-17358265d0.md): - Root [ReportCard](https://apidog.docs.sudonum.com/reportcard-17352125d0.md): - Root [PaginatedRoutingConfigList](https://apidog.docs.sudonum.com/paginatedroutingconfiglist-17352126d0.md): - Root [ContactUploadResponse](https://apidog.docs.sudonum.com/contactuploadresponse-17352127d0.md): - Root [JobCallback](https://apidog.docs.sudonum.com/jobcallback-17352128d0.md): - Root [ValidationErrorBody](https://apidog.docs.sudonum.com/validationerrorbody-17352129d0.md): - Root [ResourcesExistBody](https://apidog.docs.sudonum.com/resourcesexistbody-17352130d0.md): - Root [DetailBody](https://apidog.docs.sudonum.com/detailbody-17352131d0.md): - Root [CreateCampaignList](https://apidog.docs.sudonum.com/createcampaignlist-17352132d0.md): - Root [CreateCampaignListRequest](https://apidog.docs.sudonum.com/createcampaignlistrequest-17352133d0.md): - Root [CreateContact](https://apidog.docs.sudonum.com/createcontact-17352134d0.md): - Root [CreateContactRequest](https://apidog.docs.sudonum.com/createcontactrequest-17352135d0.md): - Root [ValidationErrorBody](https://apidog.docs.sudonum.com/validationerrorbody-17352101d0.md): - Root [CreateOptOutContactLog](https://apidog.docs.sudonum.com/createoptoutcontactlog-17352136d0.md): - Root [ExportJobResponse](https://apidog.docs.sudonum.com/exportjobresponse-17352137d0.md): - Root [ListCampaignList](https://apidog.docs.sudonum.com/listcampaignlist-17352138d0.md): - Root [ListCampaignLog](https://apidog.docs.sudonum.com/listcampaignlog-17352139d0.md): - Root [ListCampaignLogRequest](https://apidog.docs.sudonum.com/listcampaignlogrequest-17352140d0.md): - Root [ListContactList](https://apidog.docs.sudonum.com/listcontactlist-17352141d0.md): - Root [ListContacts](https://apidog.docs.sudonum.com/listcontacts-17352142d0.md): - Root [ListContactsRequest](https://apidog.docs.sudonum.com/listcontactsrequest-17352143d0.md): - Root [NullEnum](https://apidog.docs.sudonum.com/nullenum-17352144d0.md): - Root [OptOutCategoryEnum](https://apidog.docs.sudonum.com/optoutcategoryenum-17352145d0.md): - Root [OriginEnum](https://apidog.docs.sudonum.com/originenum-17352146d0.md): - Root [PaginatedListCampaignList](https://apidog.docs.sudonum.com/paginatedlistcampaignlist-17352147d0.md): - Root [PaginatedListCampaignListList](https://apidog.docs.sudonum.com/paginatedlistcampaignlistlist-17352148d0.md): - Root [PaginatedListCampaignLogList](https://apidog.docs.sudonum.com/paginatedlistcampaignloglist-17352149d0.md): - Root [PaginatedListContactsList](https://apidog.docs.sudonum.com/paginatedlistcontactslist-17352150d0.md): - Root [PaginatedListOptOutListList](https://apidog.docs.sudonum.com/paginatedlistoptoutlistlist-17352151d0.md): - Root [PaginatedListContactListList](https://apidog.docs.sudonum.com/paginatedlistcontactlistlist-17352152d0.md): - Root [PaginatedOptOutEventList](https://apidog.docs.sudonum.com/paginatedoptouteventlist-17352153d0.md): - Root [PatchedListCampaignLogRequest](https://apidog.docs.sudonum.com/patchedlistcampaignlogrequest-17352154d0.md): - Root [PatchedListContactsRequest](https://apidog.docs.sudonum.com/patchedlistcontactsrequest-17352155d0.md): - Root [PatchedUpdateCampaignListRequest](https://apidog.docs.sudonum.com/patchedupdatecampaignlistrequest-17352156d0.md): - Root [UpdateCampaignList](https://apidog.docs.sudonum.com/updatecampaignlist-17352157d0.md): - Root [UpdateCampaignListRequest](https://apidog.docs.sudonum.com/updatecampaignlistrequest-17352158d0.md):