# Datananas Documentation

> Datananas help center and API documentation

## Guides
- [Nouvelle FAQ](https://docs.datananas.com/docs/nouvelle-faq.md)

## API Reference
- [Introduction](https://docs.datananas.com/reference/introduction.md)
- [Authentication](https://docs.datananas.com/reference/authentication.md)
- [Pagination](https://docs.datananas.com/reference/pagination.md)
- [Projected fields](https://docs.datananas.com/reference/projected-fields.md)
- [Error codes](https://docs.datananas.com/reference/error-codes.md)
- [Guess contacts emails](https://docs.datananas.com/reference/post_accounts-bulk.md): Guess multiple contacts emails
- [Company to domain](https://docs.datananas.com/reference/get_accounts-domain.md): Guess which email domain will match a company name. For example: Datananas will return `datananas.com`
- [Guess email](https://docs.datananas.com/reference/get_accounts-email.md): Find possible email adresses for a contact. For example, Romain + Simon + datananas.com will return `romain@datananas.com`
- [Find activites](https://docs.datananas.com/reference/get_activities.md): Filter activities (what happened on the site) by user, contact, type, etc... Activities are sorted by creation date with the most recent first.
- [Count blacklist](https://docs.datananas.com/reference/post_blacklist-count.md): Count blacklist items according to filtered contacts
- [Filter blacklist](https://docs.datananas.com/reference/post_blacklist-filter.md): Search blacklisted email or domains according to filtered contacts
- [Find in blacklist](https://docs.datananas.com/reference/get_blacklist.md): Search blacklisted email or domains
- [Add to blacklist](https://docs.datananas.com/reference/post_blacklist.md): Creates a new blacklisted email or domain. Any contact having a matching email will not be contacted.
- [Delete blacklist](https://docs.datananas.com/reference/delete_blacklist.md): Delete a part of the blacklist according to filtered contacts
- [Remove from blacklist](https://docs.datananas.com/reference/delete_blacklist-id.md): Delete a blacklisted email or domain
- [Empty blacklist](https://docs.datananas.com/reference/delete_blacklist-all.md): Remove all the elements from the company's Blacklist
- [Brew coffee](https://docs.datananas.com/reference/get_brew.md): Does its best to brew an excellent coffee
- [Filter sequences](https://docs.datananas.com/reference/get_campaigns.md): Filter sequences by name
- [Create sequence](https://docs.datananas.com/reference/post_campaigns.md): Create a new sequence
- [Get sequence](https://docs.datananas.com/reference/get_campaigns-id.md): Get a single sequence by id
- [Delete sequence](https://docs.datananas.com/reference/delete_campaigns-id.md): Delete a sequence
- [Update sequence](https://docs.datananas.com/reference/patch_campaigns-id.md): Update an existing sequence
- [Get sequence reports](https://docs.datananas.com/reference/get_campaigns-id-reports.md): Get sequence reports for a sequence
- [Test a sequence](https://docs.datananas.com/reference/post_campaigns-id-test.md): Send all messages of a sequence to a user as if it was a contact. Emails are sent one by one, in the order defined in the sequence
- [Unsubscribe contact](https://docs.datananas.com/reference/delete_campaigns-id-contacts-contactid.md): Unsubscribe a single contact from a sequence
- [Companies introduction](https://docs.datananas.com/reference/companies-introduction.md)
- [Get a company](https://docs.datananas.com/reference/get_companies-id.md): Get a company by id. A company contains groups that contain users.
- [Update company](https://docs.datananas.com/reference/patch_companies-id.md): Update a company
- [List integrations](https://docs.datananas.com/reference/get_companies-companyid-integrations.md): List all integrations for a given company
- [Get quotas for a company](https://docs.datananas.com/reference/get_companies-id-quotas.md): Gives quotas and actual consumption for each quota
- [Check contacts validity](https://docs.datananas.com/reference/post_contacts-bulk-check.md): Checks contact validity before creating them in bulk
- [Create multiple contacts](https://docs.datananas.com/reference/post_contacts-bulk.md): Creates multiple contacts and updates existing ones. This route uses WebSocket in order to notify connected clients of the creation progress The route process is the following:   1. The webSocketServer (wss) sends one contact_bulk_create_starting   2. wss sends as many contact_bulk_create_running as there is contacts to create/update   3. wss sends one contact_bulk_create_ending The API returns between the sending of _starting and _ending WebSocket payload format:   - _starting: {       listId:  Id of the list in which contacts will be added,       uuid:    Unique transaction id     }   - _running: {       uuid:    Unique transaction id,       i:       Index of the contact currently processed,       total:   Total number of contact to process     }   - _ending: {       uuid:    Unique transaction id,       created: Number of contact created       updated: Number of contact updated     }
- [Create a contact](https://docs.datananas.com/reference/post_contacts.md): Creates a new contact
- [Get a contact](https://docs.datananas.com/reference/get_contacts-id.md): Get a contact by id
- [Delete a contact](https://docs.datananas.com/reference/delete_contacts-id.md): Delete a single contact by id
- [Update contact](https://docs.datananas.com/reference/patch_contacts-id.md): Update an existing contact
- [Count contacts](https://docs.datananas.com/reference/post_contacts-filter-count.md): Count contacts using search filters
- [Filter contacts](https://docs.datananas.com/reference/post_contacts-filter.md): Search contact by filtering them directly with criterias or with a saved filter id. To have the count of the number of contacts affected by the search, use POST /contacts/filter/count
- [Delete contacts](https://docs.datananas.com/reference/delete_contacts-filter.md): Delete multiple contacts by filters. If contactIds is present, searches and combination will be ignored.
- [Update multiple contacts](https://docs.datananas.com/reference/patch_contacts-filter.md): Update status, list or user of multiple contacts
- [Engage contacts](https://docs.datananas.com/reference/post_contacts-engage.md): Engage contacts on a sequence. The parameter senderIds is ignored when splitMethod is owner When none of the parameters contactIds, filterId and searches is given, then all contacts will be engaged in the sequence.
- [Preview contacts](https://docs.datananas.com/reference/post_contacts-engage-preview.md): Preview contacts engagement without really engaging them.
- [Validate contacts](https://docs.datananas.com/reference/post_contacts-engage-validate.md): Check whether contacts can be added in a sequence. We check for:  - blacklisted contacts  - contacts with missing variables  - contacts already added into the sequence  - contacts already added into another sequence  At most 100 contacts can be returned for each error type Only one of contactIds, filterId or searches is mandatory
- [Pause contacts](https://docs.datananas.com/reference/patch_contacts-pause.md): Pauses contacts in a sequence.   When several filters are passed as parameter, only one will be applied with the following priorities `contactIds` > `filterContact` > `filterMessage`
- [Unpause contacts](https://docs.datananas.com/reference/patch_contacts-unpause.md): Unpauses contacts in a sequence.   When several filters are passed as parameter, only one will be applied with the following priorities `contactIds` > `filterContact` > `filterMessage`
- [Unsubscribe from all sequences](https://docs.datananas.com/reference/patch_contacts-unsubscribe.md): Unsubscribe multiple contacts from all sequences
- [Upgrade contacts](https://docs.datananas.com/reference/post_contacts-datadesk.md): Use the datadesk to clean and upgrade contacts thanks to filters
- [Get contacts owners](https://docs.datananas.com/reference/post_contacts-users.md): Get information about contacts owners
- [Create note](https://docs.datananas.com/reference/post_contacts-contactid-notes.md): Create a new contact's note
- [Get static values](https://docs.datananas.com/reference/get_contacts-values.md): Get contacts list of static values. If the requested field is a value list like status or companyIndustry, all values are retrieved without pagination.
- [Find notes](https://docs.datananas.com/reference/get_contacts-contactid-notes.md): Filter contact notes with different search parameters
- [Get note](https://docs.datananas.com/reference/get_contacts-contactid-notes-noteid.md): get an existing contact's note
- [Delete note](https://docs.datananas.com/reference/delete_contacts-contactid-notes-noteid.md): Delete a contact's note
- [Update note](https://docs.datananas.com/reference/patch_contacts-contactid-notes-noteid.md): Update an existing contact's note
- [Export resources](https://docs.datananas.com/reference/post_export.md): Exports contacts or blacklists elements
- [Submit feedback about Engage](https://docs.datananas.com/reference/post_feedback.md): Submit feedback about Engage
- [Get a filter](https://docs.datananas.com/reference/get_filters-id.md): Get a filter
- [Delete saved search](https://docs.datananas.com/reference/delete_filters-id.md): Delete a filter
- [Updates a saved contact or message filter](https://docs.datananas.com/reference/patch_filters-id.md): Update filter
- [Find saved filters](https://docs.datananas.com/reference/get_filters.md): Filter filters
- [Create filter](https://docs.datananas.com/reference/post_filters.md): Create a new filter
- [Get recipients](https://docs.datananas.com/reference/get_mailbox-recipients.md): Get at most 5 of the possible recipients of a user according to a query. A recipient may be one of the contact to whom the user has access or one of its colleague. Recipients are searched by the most recently created, then they are sorted by first name, then last name, and finally by email.
- [List folders](https://docs.datananas.com/reference/get_mailbox-id-folders.md): List folders available on the user's mailbox
- [Update mailbox](https://docs.datananas.com/reference/patch_mailbox-id.md): Update mailbox properties
- [Authorize provider](https://docs.datananas.com/reference/post_integrations-authorize.md): Initializes an OAuth2 connection with an external provider or login with a direct connection
- [Provider callback](https://docs.datananas.com/reference/get_integrations-provider-callback.md): Finalize an OAuth 2 connection with an external provider
- [Create an integration](https://docs.datananas.com/reference/post_integrations.md): Create an integration
- [Revoke provider](https://docs.datananas.com/reference/delete_integrations-revoke.md): Disconnects an OAuth2 account
- [Get integrations](https://docs.datananas.com/reference/get_integrations-revoke.md): Filter integrations by type and user
- [Update integration](https://docs.datananas.com/reference/patch_integrations-id.md): Update an integration by its id
- [Get available synchronisation fields for an integration](https://docs.datananas.com/reference/get_integrations-fields.md): Get available synchronisation fields for an integration. Available integrations are Clearbit and Pipedrive
- [Get Calendly events](https://docs.datananas.com/reference/get_integrations-calendly-events.md): Fetch calendly organization events
- [Get event first availability](https://docs.datananas.com/reference/get_integrations-calendly-availability.md): Fetch Calendly event url and the first available time slot
- [Find invoices](https://docs.datananas.com/reference/get_invoices.md): Get invoices according to filters like the price or the company
- [Get an invoice](https://docs.datananas.com/reference/get_invoices-id.md): Get an invoice by id
- [Filter lists](https://docs.datananas.com/reference/get_lists.md): Filter lists of contacts
- [Create list](https://docs.datananas.com/reference/post_lists.md): Create a new list of contacts
- [Get list](https://docs.datananas.com/reference/get_lists-id.md): Get a list
- [Delete list](https://docs.datananas.com/reference/delete_lists-id.md): Delete a list
- [Update list](https://docs.datananas.com/reference/patch_lists-id.md): Edit a list of contacts
- [List media](https://docs.datananas.com/reference/get_media.md): List images
- [Get gif](https://docs.datananas.com/reference/get_media-gif.md): Search for a gif, or get trending gifs on Giphy
- [Upload media](https://docs.datananas.com/reference/post_media-upload.md): Posting a media file such as an image This route will return an upload url
- [Forward a message](https://docs.datananas.com/reference/post_messages-id-forward.md): Forward a message to at least one recipient.
- [Send a message](https://docs.datananas.com/reference/post_messages-send.md): Send a new message to at least one recipient.
- [Delete messages](https://docs.datananas.com/reference/delete_messages-filter.md): Deletes multiple messages at a time
- [Update messages](https://docs.datananas.com/reference/patch_messages-filter.md): Updates multiple messages at a time
- [Filter messages](https://docs.datananas.com/reference/post_messages-filter.md): Filter messages
- [Get a message](https://docs.datananas.com/reference/get_messages-id.md): Get a message by id
- [Update message](https://docs.datananas.com/reference/patch_messages-id.md): Update message
- [Email Rating](https://docs.datananas.com/reference/post_rate-email.md): Scores an email subject and body to help your improve it
- [Get calendar](https://docs.datananas.com/reference/get_pending-emails-calendar.md): Give an overview of scheduled and sent emails number per day and hour
- [Filter drafts](https://docs.datananas.com/reference/get_pending-emails.md): Filter pending emails based on multiple criteria
- [Update pending email](https://docs.datananas.com/reference/patch_pending-emails-id.md): Update an existing pending email
- [Find plannings](https://docs.datananas.com/reference/get_plannings.md): Get plannings to which a user have access
- [Create planning](https://docs.datananas.com/reference/post_plannings.md): Create a new Planning
- [Get a Planning](https://docs.datananas.com/reference/get_plannings-id.md): Get a Planning by id
- [Delete planning](https://docs.datananas.com/reference/delete_plannings-id.md): Delete a single planning by id
- [Update a planning](https://docs.datananas.com/reference/patch_plannings-id.md): Update a planning by id
- [Set a default planning](https://docs.datananas.com/reference/patch_plannings-id-default.md): Set the default planning for a user
- [Get stages](https://docs.datananas.com/reference/get_stages.md): Retrieve all company stages
- [Create stage](https://docs.datananas.com/reference/post_stages.md): Create a stage
- [Get stage](https://docs.datananas.com/reference/get_stages-id.md): Get a stage
- [Delete stage](https://docs.datananas.com/reference/delete_stages-id.md): Delete one stage and remove it from all contacts
- [Update stage](https://docs.datananas.com/reference/patch_stages-id.md): Update at least one of the properties [color, description, name] of a stage
- [Sequence - Comparisons](https://docs.datananas.com/reference/get_stats-campaigns.md): Gives the overall best sendings moment for a given period (UTC time) and the top 5 of your sequences and steps by clicks, opens and replies.
- [Sequence - Execution](https://docs.datananas.com/reference/get_stats-campaigns-id.md): Sequence stats by id. Some examples: * Replies by category * Contacts by states * Number of paused/active/engaged contacts
- [Sequence - Activities](https://docs.datananas.com/reference/get_stats-campaigns-id-activities.md): Day by day contacts behaviour with the sequence
- [Sequence - Performances](https://docs.datananas.com/reference/get_stats-campaigns-id-perfs.md): Contacts reception of the sequence by id: * Hyperlink click tracking * Number of Clickers/Openers by step * sent emails, number of added contacts
- [User - Global](https://docs.datananas.com/reference/get_stats-users.md): How each user of the company performed
- [Contact - Global](https://docs.datananas.com/reference/get_stats-contacts.md): Picture of a company's contacts states at a given time
- [Complete task](https://docs.datananas.com/reference/patch_tasks-id-complete.md): Mark a task as completed
- [Create task](https://docs.datananas.com/reference/post_tasks.md): create a new task
- [Filter tasks](https://docs.datananas.com/reference/get_tasks.md): Filter tasks with different search parameters
- [Update task](https://docs.datananas.com/reference/patch_tasks-id.md): Edit a task
- [Get template](https://docs.datananas.com/reference/get_templates-id.md): Get an email template
- [Delete template](https://docs.datananas.com/reference/delete_templates-id.md): Delete an email template. When a template is associated to a smart reply, it cannot be deleted
- [Edit template](https://docs.datananas.com/reference/patch_templates-id.md): Edit an email template
- [List templates](https://docs.datananas.com/reference/get_templates.md): List email templates
- [Create template](https://docs.datananas.com/reference/post_templates.md): Create a new email template
- [Add user to company](https://docs.datananas.com/reference/post_users.md): Creates a new user within the requester's company
- [Deactivate user](https://docs.datananas.com/reference/post_users-deactivate.md): Deactivate one user
- [Enable users](https://docs.datananas.com/reference/post_users-enable.md): Enable one or more user
- [Filter users](https://docs.datananas.com/reference/get_users.md): Filter users
- [Get user](https://docs.datananas.com/reference/get_users-id.md): Get a user by id.
- [Update user](https://docs.datananas.com/reference/patch_users-id.md): Update an user
- [Revoke access token](https://docs.datananas.com/reference/delete_users-integrations-revoke.md): Revoke the right for a user to access to an integration
- [Login](https://docs.datananas.com/reference/post_users-login.md): Login to your your Datananas account with email and password.  Applications connected via Oauth2 can use this route to generate a login url for users
- [Log out user](https://docs.datananas.com/reference/post_users-logout.md): Log out a user by removing its access token
- [Get connected user](https://docs.datananas.com/reference/get_users-me.md): Get the user connected
- [Get onboarding](https://docs.datananas.com/reference/get_users-me-onboarding.md): Get the user onboarding step done - `add_infos` User has completed basic infos and signature - `connect_email` User has an email connected - `invite_team` User has invited team members - `install_addon` User has installed addon and logged in once - `create_variable` User has created a variable - `create_sequence` User has created a sequence - `create_contact` User has created a contact - `engage_contacts` User has engaged contacts - `subscribe` User has subscribed to a paying plan
- [Change password](https://docs.datananas.com/reference/patch_users-password.md): Change the password using a token
- [Register user](https://docs.datananas.com/reference/post_users-register.md): Creates a new user and its company
- [Reset password](https://docs.datananas.com/reference/post_users-password-reset.md): Request reset password
- [Resync user](https://docs.datananas.com/reference/get_users-id-resync.md): Restart resynchronizing messages from user's mailbox since 1 month ago
- [List user's roles](https://docs.datananas.com/reference/get_users-id-roles.md): List all roles for a given user
- [Grant roles](https://docs.datananas.com/reference/patch_users-id-roles.md): Get all roles to show if the role is allowed for a given user
- [Oauth2 authentication flow](https://docs.datananas.com/reference/overview-oauth2.md)
- [Authorize](https://docs.datananas.com/reference/get_users-authorize.md): Once the user has entered his credentials, he will be redirected to the page you specified in `redirect_uri`. You will be able to get `code` and `state` from url parameters.
- [Get access token](https://docs.datananas.com/reference/post_users-integrations-grant.md): Retrieve an access token and a refresh token using a unique usage code
- [Refresh access token](https://docs.datananas.com/reference/post_users-refresh.md): Get a new access token using a refresh token. Since access tokens have a short lifespan, you can get new ones using your refesh tokens.
- [Filter variables](https://docs.datananas.com/reference/get_variables.md): List all variables according to scopes. Can be filtered
- [Create variable](https://docs.datananas.com/reference/post_variables.md): Create a new variable that can be used in emails
- [Delete variable](https://docs.datananas.com/reference/delete_variables-id.md): Delete a variable
- [Create webhook](https://docs.datananas.com/reference/post_webhooks.md): Create a new webhook endpoint for one or multiple events
- [Delete webhook](https://docs.datananas.com/reference/delete_webhooks-id.md): Deletes a webhook by id
- [Update webhook](https://docs.datananas.com/reference/patch_webhooks-id.md): Update a webhook for one or multiple events
- [Test webhook](https://docs.datananas.com/reference/get_webhooks-event-test.md): Get a sample webhook for a specific event.
- [Contact status change](https://docs.datananas.com/reference/contact-status-change.md)
- [New Contact](https://docs.datananas.com/reference/new-contact.md)
- [New Reply](https://docs.datananas.com/reference/new-replies.md)

## Changelog
- [Bibliothèque de séquences](https://docs.datananas.com/changelog/bibliothèque-de-séquences.md)
- [Summer release !](https://docs.datananas.com/changelog/summer-release.md)
- [Nouvelle Academy et amélioration de la gestion des contacts](https://docs.datananas.com/changelog/nouvelle-academy-et-amélioration-de-la-gestion-des-contacts.md)
- [Statistiques de séquences et factures](https://docs.datananas.com/changelog/statistiques-de-séquences-et-disponibilité-des-factures.md)
- [Roadmap publique et préférences d'affichage](https://docs.datananas.com/changelog/roadmap-publique.md)
- [Fiche contact, ergonomie et tableau de bord](https://docs.datananas.com/changelog/fiche-contact-ergonomie-et-tableau-de-bord.md)
- [Signature et vue contacts](https://docs.datananas.com/changelog/signature-et-vue-contact.md)
- [Sélection massive](https://docs.datananas.com/changelog/sélection-massive.md)
- [Onboarding vidéo, Nouvelle vue contact, Import CSV et Blacklist](https://docs.datananas.com/changelog/2503.md)
- [Amélioration des performances](https://docs.datananas.com/changelog/200319-amélioration-des-performances.md)