# Doc Partner ## Doc Partner - FR - [Bienvenue](https://www.docpartner.dev/readme.md): Bienvenue sur la documentation de nos API SMS Partner, Voice Partner et Mail Partner. - [SMS Partner](https://www.docpartner.dev/api/sms-partner.md): Introduction à l'api SMS Partner - [Webhooks](https://www.docpartner.dev/api/sms-partner/gestion-des-webhooks.md): Gérer les statuts et réponses de vos campagnes SMS - [Crédits](https://www.docpartner.dev/api/sms-partner/credits.md): Cette requête est utilisée pour récupérer votre crédit disponible de SMS, ainsi que le nombre de SMS en instance de départ. - [Sous-comptes](https://www.docpartner.dev/api/sms-partner/sous-comptes.md): Gérer vos sous-comptes. - [Activation](https://www.docpartner.dev/api/sms-partner/sous-comptes/activation.md): Découvrez comment activer la fonctionnalité création de sous-comptes. - [Création d'un sous compte](https://www.docpartner.dev/api/sms-partner/sous-comptes/creation-dun-sous-compte.md): Cette requête est utilisée pour créer un sous-compte. - [Supprimer un sous-compte](https://www.docpartner.dev/api/sms-partner/sous-comptes/supprimer-un-sous-compte.md): Cette requête est utilisée pour supprimer un sous-compte. - [Liste des sous-comptes](https://www.docpartner.dev/api/sms-partner/sous-comptes/liste-des-sous-comptes.md): Cette requête est utilisée pour lister les sous-comptes de votre compte principal. - [Gérer les crédits des sous-comptes](https://www.docpartner.dev/api/sms-partner/sous-comptes/gerer-les-credits-des-sous-comptes.md): Cette requête est utilisée pour créer un sous-compte. - [Rate limiting](https://www.docpartner.dev/api/sms-partner/rate-limiting.md) - [Envoyer des SMS](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms.md): Les différentes méthode d'envoi de SMS - [Compteur de caractères](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/compteur-de-caracteres.md): Estime un SMS avant envoi : nombre de segments, encodage détecté, prix unitaire et coût total, selon le tarif de votre compte. - [Envoi unitaire](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/envoi-unitaire.md): Cette requête est utilisée pour envoyer des SMS en temps réel ou en différé. - [Envoi par lots](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/envoi-par-lots.md): Cette requête est utilisée pour envoyer des SMS en temps réel ou en différé. - [Envoi par numéro long](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/envoi-par-numero-long.md): Cette requête est utilisée pour envoyer des SMS avec un numéro long. Un numéro long est un numéro sous cette forme : +337XXXXXXXX - [Envoi de sondages](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/envoi-sondages.md): Cette requête est utilisée pour envoyer un sondage en temps réel ou en différé. - [Annuler l'envoi d'un SMS différé](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/annuler-envoi-d-un-sms-differe.md): Cette requête est utilisée pour annuler l’envoi d’un SMS envoyé en différé. - [Caractères spéciaux](https://www.docpartner.dev/api/sms-partner/envoyer-des-sms/caracteres-speciaux.md): Liste des caractères spéciaux remplacés lors de l'envoi du SMS. - [Statut & Statistiques](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques.md): Les différentes méthode d'envoi de SMS - [Statut unitaire](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques/statut-unitaire.md): Cette requête permet de récupérer le statut d’un SMS. - [Statut multiple](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques/statut-multiple.md): Cette requête permet de récupérer le statut de plusieurs SMS (maximum 500 numéros). - [Statut par message](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques/statut-par-message.md): Cette requête permet de récupérer les statuts de plusieurs SMS à partir d’un ID. - [Statut par tag](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques/statut-par-tag.md): Cette requête permet de récupérer les statuts de plusieurs SMS à partir d’un Tag. - [Statistique des envois](https://www.docpartner.dev/api/sms-partner/statut-et-statistiques/statistique-des-envois.md): Cette requête est utilisée pour récupérer les statistiques des envois sur une période précise. Elle permet de récupérer le nombre de SMS envoyés et le cout associé à ces envoi - [Gestion des contacts](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts.md): Gérer vos groupes et contacts - [Ajouter un groupe](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/ajouter-un-groupe.md): Cette requête est utilisée pour créer un groupe de contacts - [Ajouter un contact](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/ajouter-un-contact.md): Cette requête est utilisée pour créer un contact au sein d'un groupe - [Supprimer un groupe](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/supprimer-un-groupe.md): Cette requête est utilisée pour supprimer un groupe - [Ajouter un lot de contacts](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/ajouter-un-lot-de-contacts.md): Cette requête est utilisée pour ajouter un lot de 500 contacts (maximum). - [Modifier un contact](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/modifier-un-contact.md): Cette requête est utilisée pour modifier un contact déjà existant - [Supprimer un contact](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/supprimer-un-contact.md): Cette requête est utilisée pour supprimer un contact - [Obtenir la liste des groupes](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/obtenir-la-liste-des-groupes.md): Cette requête est utilisée pour obtenir la liste des groupes de contacts - [Obtenir la liste des contacts](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/obtenir-la-liste-des-contacts.md): Cette requête est utilisée pour obtenir la liste des contacts d'un groupe - [Obtenir le détail d'un contact](https://www.docpartner.dev/api/sms-partner/gestion-des-contacts/obtenir-le-detail-dun-contact.md): Cette requête est utilisée pour obtenir le détail d'un contact - [Gestion des stops](https://www.docpartner.dev/api/sms-partner/gestion-des-reponses-stops.md): Gérer vos réponses et stops sms - [Liste des stops](https://www.docpartner.dev/api/sms-partner/gestion-des-reponses-stops/liste-des-stops.md): Cette requête est utilisée pour obtenir la liste des stops SMS - [Ajouter un numéro au stop SMS](https://www.docpartner.dev/api/sms-partner/gestion-des-reponses-stops/ajouter-un-numero-au-stop-sms.md): Cette requête permet d'ajouter un numéro à la liste des stops - [Supprimer un numéro du STOP SMS](https://www.docpartner.dev/api/sms-partner/gestion-des-reponses-stops/supprimer-un-numero-du-stop-sms.md): Cette requête permet de supprimer un numéro de la liste des stops. - [RCS](https://www.docpartner.dev/api/sms-partner/rcs.md) - [Scénario RCS](https://www.docpartner.dev/api/sms-partner/rcs/rcs-scenario.md): Cette requête démarre un scénario RCS pour une liste de numéros à partir de son identifiant (token). - [Vérification de numéros](https://www.docpartner.dev/api/sms-partner/verification-de-numeros.md): Gérer vos réponses et stops sms - [Envoyer une vérification](https://www.docpartner.dev/api/sms-partner/verification-de-numeros/envoyer-une-verification.md): Cette requête est utilisée pour envoyer une vérification HLR. - [Vérification de format](https://www.docpartner.dev/api/sms-partner/verification-de-numeros/verification-de-format.md): Cette requête est utilisée pour vérifier le format d'un numéro de téléphone portable. Elle est disponible gratuitement. - [Location de contacts](https://www.docpartner.dev/api/sms-partner/location-de-contacts.md): Louer une base de donnée de numéros pour votre compagne SMS ! - [Catégories](https://www.docpartner.dev/api/sms-partner/location-de-contacts/categories.md): Liste des catégories et sous-catégories. - [Ciblage et calcul](https://www.docpartner.dev/api/sms-partner/location-de-contacts/ciblage-et-calcul.md): Cette requête permet de calculer le ciblage, et le coût du ciblage. - [Statut d'une location](https://www.docpartner.dev/api/sms-partner/location-de-contacts/statut-dune-location.md): Cette requête permet de récupérer permet de récupérer le statut d’une location de contacts. - [Télécharger le fichier](https://www.docpartner.dev/api/sms-partner/location-de-contacts/telecharger-le-fichier.md): Cette requête permet de télécharger le fichier de la location - [HubSpot](https://www.docpartner.dev/api/sms-partner/hubspot.md) - [Voice Partner](https://www.docpartner.dev/api/voice-partner.md): Introduction à l'api Voice Partner - [Webhooks](https://www.docpartner.dev/api/voice-partner/gestion-des-webhooks.md): Recevoir les statuts de vos campagnes vocales - [Crédits](https://www.docpartner.dev/api/voice-partner/credits.md): Cette requête est utilisée pour récupérer votre crédit disponible de messages vocaux, dépôt de messages. - [Sous-comptes](https://www.docpartner.dev/api/voice-partner/sous-comptes.md): Gérer vos sous-comptes. - [Activation](https://www.docpartner.dev/api/voice-partner/sous-comptes/activation.md): Découvrez comment activer la fonctionnalité création de sous-comptes. - [Création d'un sous compte](https://www.docpartner.dev/api/voice-partner/sous-comptes/creation-dun-sous-compte.md): Cette requête est utilisée pour créer un sous-compte. - [Supprimer un sous-compte](https://www.docpartner.dev/api/voice-partner/sous-comptes/supprimer-un-sous-compte.md): Cette requête est utilisée pour supprimer un sous-compte. - [Liste des sous-comptes](https://www.docpartner.dev/api/voice-partner/sous-comptes/liste-des-sous-comptes.md): Cette requête est utilisée pour lister les sous-comptes de votre compte principal. - [Gérer les crédits des sous-comptes](https://www.docpartner.dev/api/voice-partner/sous-comptes/gerer-les-credits-des-sous-comptes.md): Cette requête est utilisée pour créer un sous-compte. - [Message Vocal](https://www.docpartner.dev/api/voice-partner/message-vocal.md): Gérer vos messages vocaux - [Liste des fichiers audio](https://www.docpartner.dev/api/voice-partner/message-vocal/liste-des-fichiers-audio.md): Récupéré la liste des fichiers audios ajoutés et validés - [Renommer un fichier audio](https://www.docpartner.dev/api/voice-partner/message-vocal/renommer-un-fichier-audio.md): Renommer un fichier audio déjà existant - [Déposer un message vocal](https://www.docpartner.dev/api/voice-partner/message-vocal/deposer-un-message-vocal.md): Le dépôt d’un message vocal (VMS) est disponible sur l’API. Le dépôt fonctionne sur les fixes et sur les mobiles. Il est important de noter que le fonctionnement est différent. - [Envoyer un SMS Vocal](https://www.docpartner.dev/api/voice-partner/envoyer-un-sms-vocal.md): Cette requête est utilisée pour envoyer un SMS Vocal sur mobile - [Supprimer un envoi différé](https://www.docpartner.dev/api/voice-partner/supprimer-un-envoi-differe.md): Cette requête est utilisée pour annuler l'envoi différé d'un message vocal ou sms vocal - [Mail Partner](https://www.docpartner.dev/api/mail-partner.md): Introduction à l'api Mail Partner - [Webhooks](https://www.docpartner.dev/api/mail-partner/gestion-des-webhooks.md): Gérer les statuts de vos campagnes mails - [Crédits](https://www.docpartner.dev/api/mail-partner/credits.md): Cette requête est utilisée pour récupérer votre crédit disponible de mail. - [Sous-comptes](https://www.docpartner.dev/api/mail-partner/sous-comptes.md): Gérer vos sous-comptes - [Activation](https://www.docpartner.dev/api/mail-partner/sous-comptes/activation.md): Découvrez comment activer la fonctionnalité création de sous-comptes. - [Création d'un sous compte](https://www.docpartner.dev/api/mail-partner/sous-comptes/creation-dun-sous-compte.md): Cette requête est utilisée pour créer un sous-compte. - [Liste des sous-comptes](https://www.docpartner.dev/api/mail-partner/sous-comptes/liste-des-sous-comptes.md): Cette requête est utilisée pour lister les sous-comptes de votre compte principal. - [Gérer les crédits des sous-comptes](https://www.docpartner.dev/api/mail-partner/sous-comptes/gerer-les-credits-des-sous-comptes.md): Ces requêtes sont utilisées pour ajouter ou retirer des crédits à un sous-compte. - [Rate limiting](https://www.docpartner.dev/api/mail-partner/rate-limiting.md) - [Envoi unitaire de mail](https://www.docpartner.dev/api/mail-partner/envoi-unitaire.md): Cette requête est utilisée pour envoyer des mails en temps réel ou en différé. - [Annuler l'envoi d'un mail](https://www.docpartner.dev/api/mail-partner/annuler-lenvoi-dun-mail.md): Cette requête est utilisée pour annuler l’envoi d’un mail programmé en différé. - [Statut par message](https://www.docpartner.dev/api/mail-partner/statut-par-message.md): Cette requête est utilisée pour récupérer le statut de chaque destinataire d’un message. - [Gestion des désabonnements](https://www.docpartner.dev/api/mail-partner/gestion-des-desabonnements.md): Gérez vos désabonnements mails - [Ajouter un mail](https://www.docpartner.dev/api/mail-partner/gestion-des-desabonnements/ajouter-un-mail.md): Cette requête permet d’ajouter un mail à la liste des désinscriptions. - [Liste des désabonnements](https://www.docpartner.dev/api/mail-partner/gestion-des-desabonnements/liste-des-desabonnements.md): Cette requête est utilisée pour récupérer la liste des mails désinscrits. - [Supprimer un mail](https://www.docpartner.dev/api/mail-partner/gestion-des-desabonnements/supprimer-un-mail.md): Cette requête permet de supprimer un mail de la liste des désinscriptions. - [Codes d'erreur](https://www.docpartner.dev/api/codes-derreur.md): Liste de tous les codes d'erreur - [SDKS](https://www.docpartner.dev/sdks.md): Dans le cadre de vos envois sur SMS Partner, nous proposons des SDK officiels sur de nombreux langages de programmation afin que vous puissiez facilement envoyer vos messages à ajouter des messages. ## Doc Partner - EN - [Welcome](https://www.docpartner.dev/en/readme.md): Welcome to the documentation of our SMS Partner, Voice Partner and Mail Partner APIs. - [SMS Partner](https://www.docpartner.dev/en/api/sms-partner.md): Introduction to the SMS Partner API - [Webhooks](https://www.docpartner.dev/en/api/sms-partner/webhooks.md): Manage the statuses and replies of your SMS campaigns - [Credits](https://www.docpartner.dev/en/api/sms-partner/credits.md): This request is used to retrieve your available SMS credits, as well as the number of pending outgoing SMS. - [Sub-accounts](https://www.docpartner.dev/en/api/sms-partner/sub-accounts.md): Manage your sub-accounts. - [Activation](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Delete Sub-account](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/delete-sub-account.md): This request is used to delete a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/sms-partner/sub-accounts/manage-sub-account-credits.md): This request is used to manage sub-account credits. - [Rate limiting](https://www.docpartner.dev/en/api/sms-partner/rate-limiting.md) - [Send SMS](https://www.docpartner.dev/en/api/sms-partner/send-sms.md): Les différentes méthode d'envoi de SMS - [Character counter](https://www.docpartner.dev/en/api/sms-partner/send-sms/character-counter.md): Estimate an SMS before sending: number of segments, detected encoding, unit price and total cost, based on your account's rate. - [Single Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/single-send.md): This request is used to send SMS in real-time or scheduled. - [Bulk Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/bulk-send.md): This request is used to send SMS messages in real-time or scheduled. - [Send by Long Number](https://www.docpartner.dev/en/api/sms-partner/send-sms/send-by-long-number.md): This request is used to send SMS using a long number. A long number looks like: +337XXXXXXXX - [Survey Send](https://www.docpartner.dev/en/api/sms-partner/send-sms/survey-send.md): This request is used to send a survey in real-time or scheduled. - [Cancel Scheduled SMS](https://www.docpartner.dev/en/api/sms-partner/send-sms/cancel-scheduled-sms.md): This request is used to cancel a scheduled SMS. - [Special Characters](https://www.docpartner.dev/en/api/sms-partner/send-sms/special-characters.md): List of special characters replaced when sending an SMS. - [Status & Statistics](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics.md): Different SMS sending methods - [Single Status](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/single-status.md): This request allows you to retrieve the status of a single SMS. - [Bulk Status](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/bulk-status.md): This request allows you to retrieve the status of multiple SMS (up to 500 numbers). - [Status by Message](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/status-by-message.md): This request allows you to retrieve the statuses of multiple SMS using a message ID. - [Status by Tag](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/status-by-tag.md): This request allows you to retrieve the statuses of multiple SMS using a tag. - [Sending Statistics](https://www.docpartner.dev/en/api/sms-partner/status-and-statistics/sending-statistics.md): This request is used to retrieve sending statistics over a specific period. It returns the number of SMS sent and the associated cost. - [Contact Management](https://www.docpartner.dev/en/api/sms-partner/contact-management.md): Manage your contact groups and contacts - [Add Group](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-group.md): This request is used to create a new contact group - [Add Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-contact.md): This request is used to create a contact within a group - [Delete Group](https://www.docpartner.dev/en/api/sms-partner/contact-management/delete-group.md): This request is used to delete a group - [Add Bulk Contacts](https://www.docpartner.dev/en/api/sms-partner/contact-management/add-bulk-contacts.md): This request is used to add a batch of up to 500 contacts. - [Edit Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/edit-contact.md): This request is used to update an existing contact. - [Delete Contact](https://www.docpartner.dev/en/api/sms-partner/contact-management/delete-contact.md): This request is used to delete a contact - [Get Group List](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-group-list.md): This request is used to retrieve the list of contact groups - [Get Contact List](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-contact-list.md): This request is used to retrieve the list of contacts in a group - [Get Contact Details](https://www.docpartner.dev/en/api/sms-partner/contact-management/get-contact-details.md): This request is used to retrieve the details of a contact - [Replies / Opt-outs Management](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management.md): Manage your replies and SMS opt-outs - [Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/stop-list.md): This request is used to retrieve the list of SMS opt-outs - [Add Number to SMS Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/add-number-to-sms-stop-list.md): This request is used to add a number to the SMS stop list - [Remove Number from SMS Stop List](https://www.docpartner.dev/en/api/sms-partner/replies-opt-outs-management/remove-number-from-sms-stop-list.md): This request is used to remove a number from the SMS stop list. - [RCS](https://www.docpartner.dev/en/api/sms-partner/rcs.md) - [RCS Scenario](https://www.docpartner.dev/en/api/sms-partner/rcs/rcs-scenario.md): This request starts an RCS scenario for a list of numbers from its identifier (token). - [Number Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification.md): Manage your replies and SMS opt-outs - [Send a Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification/send-a-verification.md): This request is used to send an HLR verification. - [Format Verification](https://www.docpartner.dev/en/api/sms-partner/number-verification/format-verification.md): This request is used to check the format of a mobile number. It is available for free. - [Contact Rental](https://www.docpartner.dev/en/api/sms-partner/contact-rental.md): Rent a database of phone numbers for your SMS campaign! - [Categories](https://www.docpartner.dev/en/api/sms-partner/contact-rental/categories.md): List of categories and subcategories. - [Targeting & Calculation](https://www.docpartner.dev/en/api/sms-partner/contact-rental/targeting-and-calculation.md): This request allows you to calculate targeting and its cost. - [Rental Status](https://www.docpartner.dev/en/api/sms-partner/contact-rental/rental-status.md): This request allows you to retrieve the status of a contact rental. - [Download File](https://www.docpartner.dev/en/api/sms-partner/contact-rental/download-file.md): This request allows you to download the file of the location - [Voice Partner](https://www.docpartner.dev/en/api/voice-partner.md): Introduction to the Voice Partner API - [Webhooks](https://www.docpartner.dev/en/api/voice-partner/statuses.md): Receive the statuses of your voice campaigns - [Credits](https://www.docpartner.dev/en/api/voice-partner/credits.md): This request is used to retrieve your available voice message and voicemail drop credit. - [Sub-accounts](https://www.docpartner.dev/en/api/voice-partner/sub-accounts.md): Manage your sub-accounts. - [Activation](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Delete Sub-account](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/delete-sub-account.md): This request is used to delete a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/voice-partner/sub-accounts/manage-sub-account-credits.md): This request is used to create a sub-account. - [Voice Message](https://www.docpartner.dev/en/api/voice-partner/voice-message.md): Manage your voice messages - [Audio File List](https://www.docpartner.dev/en/api/voice-partner/voice-message/audio-file-list.md): Retrieve the list of audio files added and validated - [Rename an Audio File](https://www.docpartner.dev/en/api/voice-partner/voice-message/rename-audio-file.md): Rename an already existing audio file - [Upload a Voice Message](https://www.docpartner.dev/en/api/voice-partner/voice-message/upload-a-voice-message.md): Uploading a voice message (VMS) is available via the API. Uploading works for both landlines and mobiles. It is important to note that the behavior is different. - [Send a Voice SMS](https://www.docpartner.dev/en/api/voice-partner/send-a-voice-sms.md): This request is used to send a Voice SMS to a mobile phone - [Cancel a Scheduled Send](https://www.docpartner.dev/en/api/voice-partner/cancel-scheduled-send.md): This request is used to cancel the scheduled sending of a voice message or voice SMS - [Mail Partner](https://www.docpartner.dev/en/api/mail-partner.md): Introduction to the Mail Partner API - [Webhooks](https://www.docpartner.dev/en/api/mail-partner/webhooks.md): Manage the statuses of your email campaigns - [Credits](https://www.docpartner.dev/en/api/mail-partner/credits.md): This request is used to retrieve your available email credit. - [Sub-accounts](https://www.docpartner.dev/en/api/mail-partner/sub-accounts.md): Manage your sub-accounts - [Activation](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/activation.md): Learn how to activate the sub-account creation feature. - [Create Sub-account](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/create-sub-account.md): This request is used to create a sub-account. - [Sub-account List](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/sub-account-list.md): This request is used to list the sub-accounts of your main account. - [Manage Sub-account Credits](https://www.docpartner.dev/en/api/mail-partner/sub-accounts/manage-sub-account-credits.md): These requests are used to add or remove credits from a sub-account. - [Rate limiting](https://www.docpartner.dev/en/api/mail-partner/rate-limiting.md) - [Single Email Send](https://www.docpartner.dev/en/api/mail-partner/single-send.md): This request is used to send emails in real time or scheduled. - [Cancel an Email Send](https://www.docpartner.dev/en/api/mail-partner/cancel-email-send.md): This request is used to cancel a scheduled email send. - [Status by Message](https://www.docpartner.dev/en/api/mail-partner/status-by-message.md): This request is used to retrieve the status of each recipient of a message. - [Unsubscribe Management](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management.md): Manage your email unsubscriptions - [Add an Email](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/add-email.md): This request lets you add an email to the unsubscribe list. - [Unsubscribe List](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/unsubscribe-list.md): This request is used to retrieve the list of unsubscribed emails. - [Delete an Email](https://www.docpartner.dev/en/api/mail-partner/unsubscribe-management/delete-email.md): This request lets you remove an email from the unsubscribe list. - [Error Codes](https://www.docpartner.dev/en/api/error-codes.md): List of all error codes - [SDKS](https://www.docpartner.dev/en/sdks.md): As part of your sending on SMS Partner, we offer official SDKs in many programming languages so you can easily send your messages and add messages. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://www.docpartner.dev/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.