Tatodesk API
Consumption of tatodesk APIs.
Click a topic below to directly access the detailed documentation for each item:
In-Person Service:
Marketing:
WhatsApp:
SMS:
Data API:
CRM:
Contact Center:
Pulse:
In-Person Service
Post List companies by user
You must use an API-KEY linked to an authorized user to make the request.
Request Example
Response Example
Post List Service Units by User
You must use an API-KEY linked to an authorized user to make the request.
Request Example
Response Example
Post List Service Classifications
Request Example
Response Example
Post List Service Categories
Request Example
Response Example
Post List Service Types
Request Example
Response Example
Post List Form Fields
Request Example
Response Example
Post Create In-Person Service
Request Example
Response Example
Post List Companies for the Custom Link
Request Example
Response Example
Post List Categories for Scheduling
Description: Returns all service categories available for scheduling in a specific company.
Request Example
Response Example
Post List Categories of the Custom Link
Description:
Returns the categories associated with a custom scheduling link identified by a token.
Request Example:
Response Example:
Post List Service Types for Scheduling
Description: Returns the service types available within a specific category, used in the next step of scheduling.
Request Example:
Response Example:
Post List Regions for Scheduling
Description: Returns the list of regions available for scheduling, based on the provided attendance types. This endpoint is used after selecting the attendance type, to identify where it can be performed.
Request Example:
Response Example:
Post List Service Units for Scheduling
Description: Returns the list of attendance units available for a given attendance type and region. This endpoint is used after selecting the region, allowing the user to choose where where the attendance will be performed.
Request Example:
Response Example:
Post List Dates for Scheduling
Description: Returns the list of available dates to make the appointment at a specific unit and attendance type.
Request Example
Response Example
Post List Periods for Scheduling
Description: Returns the available periods (e.g.: morning, afternoon, evening) for scheduling on a specific date, unit and attendance type.
Request Example
Example Response
Post List Hours for Appointment
Description: Returns the list of available times within a given period (morning, afternoon, evening) for scheduling.
Request Example
Response Example
Post Create Appointment
Description: Creates a new appointment in the Tatodesk system, based on the selected company, unit, type and date information.
Request Example:
Response Example:
Post Query Appointment
Description: Retrieves the complete details of an appointment already created, using the attendance protocol returned at the time of creation.
Request Example:
Example Response:
Post Get In-Person Service
Description: Retrieves detailed information about an in-person attendance performed or scheduled, from the attendance ID.
Request Example:
Example Response:
Post Add Attachments
Description: Allows associating attachments (files) to an existing attendance, using the appointment protocol. The attachments are sent through pre-stored URLs on Tatodesk's server.
Request Example:
Response Example:
Marketing
Post Send notifications via Email
Description: Allows send notifications by email using a template configured in Tatodesk. Supports sending attachments and dynamic parameters inside the message body.
Request Example:
WhatsApp
Post Add Attachments
Description: Performs the upload of media files (images, audios, videos, documents etc.) to the WhatsApp server via Tatodesk, generating a mediaID that can be used later when sending messages.
Request Example:
Response Example:
Post Send Notification via WhatsApp
Description: Sends a template message via WhatsApp to a specific number, using a model previously approved by the WhatsApp Business API. Allows including images, dynamic parameters and metadata for campaign tracking.
Request Example:
Post Send Notification via WhatsApp - Using Media Upload
Description:
Upload a file to the 'media upload' service and, in case of success (status code 200), receive a UUID in the response. Use this UUID in the "id" field inside templatePayload -> header, as illustrated in the example below.
Request Example:
SMS
Post Send notification via SMS
Description: Allows the sending of SMS messages based on templates, using dynamic parameters and custom metadata. Ideal for automatic notifications, reminders and campaigns.
Request Example:
Data API
Post Digital Services Report
API to list digital attendances:
filter (required) object with the query filter
dateInitial (required) initial date in the format DD/MM/YYYY.
dateFinal (required) final date in the format DD/MM/YYYY.
protocol (optional) text with the attendance protocol.
sessionID (optional) text with the attendance session.
statusIDs (optional) list of numeric values
departmentIDs (optional) list of numeric values
userIDs (optional) list of numeric values
tagIDs (optional) list of numeric values
channelIDs (optional) list of numeric values
rates (optional) list of numeric values
sentiments (optional) list of numeric values
attendanceTime (optional) object to select attendances by attendance time:
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
waitingTime (optional) object to select attendances by waiting time
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
firstAgentReply (optional) object to select attendances by the time of the first agent reply:
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
timeAgentClientReply (optional) object to select attendances by the time of the agent's reply to the client
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
timeClientAgentReply (optional) object to select attendances by the time of the client's reply to the agent
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
form (optional) object to select attendances by form:
key (required) text with the form key
value (required) text with the form value
additionalData (optional) object to select attendances by additional data
ID (required) text with the identifier of the additional information
value (required) text with the value of the additional information
page (required) positive numeric value (values starting from 0) that represents the query page.
limit (optional) positive numeric value (values starting from 1) that represents the number of records in each query; if not provided the default value is 1000.
Request Example:
Response Example:
Post Campaigns Report
API to list campaign information:
filter (required) object with the query filter
dateInitial (required) initial date in the format DD/MM/YYYY.
dateFinal (required) final date in the format DD/MM/YYYY.
archived (optional) numeric value indicating whether the campaign is archived or not.
1 - Yes
2 - No
departmentIDs (optional) list of numeric values
page (required) positive numeric value (values starting from 0) that represents the query page.
limit (optional) positive numeric value (values starting from 1) that represents the number of records in each query; if not provided the default value is 100000.
Request Example:
Response Example:
POST In-Person Services Report
API to list in-person attendances:
filter (required) object with the query filter:
dateInitial (required) initial date in the format DD/MM/YYYY.
dateFinal (required) final date in the format DD/MM/YYYY.
protocol (optional) text with the attendance protocol.
attendanceCode (optional) text with the attendance password.
companyIDs (optional) list of numeric values
attendanceUnitIDs (optional) list of numeric values
attendanceTypeIDs (optional) list of numeric values
statusIDs (optional) list of numeric values
userIDs (optional) list of numeric values
tagIDs (optional) list of numeric values
attendanceTime (optional) object to select attendances by attendance duration
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
waitingTime (optional) object to select attendances by waiting time
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
pausedTime (optional) object to select attendances by agent's first response time
operation (required) numeric value with the operation. 1 - Less 2 - Less or equal 3 - Greater 4 - Greater or equal 5 - Between
value (required) numeric value in minutes.
valueFinal (required when the operation value is 5) numeric value in minutes.
form (optional) object to select attendances by form:
key (required) text with the form key
value (required) text with the form value
additionalData (optional) object to select attendances by additional data
ID (required) text with the identifier of the additional information
value (required) text with the value of the additional information
page (required) positive numeric value (values starting from 0) that represents the query page.
limit (optional) positive numeric value (values starting from 1) that represents the number of records in each query, if not informed the default value is 1000.
Request Example:
Response Example:
POST Tickets Report
API to list tickets:
filter (required) object with the query filter:
dateInitial (required) initial date in the format DD/MM/YYYY.
dateFinal (required) final date in the format DD/MM/YYYY.
protocol (optional) text with the attendance protocol.
statusIDs (optional) list of numeric values
organizationIDs (optional) list of numeric values
projectIDs (optional) list of numeric values
departmentIDs (optional) list of numeric values
userIDs (optional) list of numeric values
form (optional) object to select attendances by additional data
key (required) text with the form key
value (required) text with the form value
page (required) positive numeric value (values starting from 0) that represents the query page.
limit (optional) positive numeric value (values starting from 1) that represents the number of records in each query, if not informed the default value is 1000.
Request Example:
Response Example:
Post Search by protocol
Description: Allows searching detailed information of a protocol across multiple Tatodesk platforms, such as digital attendance, in-person, tickets or MP. Ideal for checking status, dates and data of records already created.
Request Example:
Response Example:
Post Sessions Report
Description: This endpoint allows to query messaging sessions reports (webchat, WhatsApp, etc.) within a specific period. It is useful for audits, service metrics and tracking user interactions across multiple channels.
Request Example:
Response Example:
POST Grouped Journey Report
Description: Returns chatbot journey events grouped by level and tag, within a defined period. Ideal for user flow reports and performance analysis of automated journeys.
Request Example:
Response Example:
POST Detailed Journey Report
Description: Returns all individual events of a chatbot journey within a period, with detailed information about each interaction, session and step the user went through.
Request Example:
Response Example:
POST Ad-hoc Notifications Report
Description: Returns a detailed report of loose notifications (SMS, email or WhatsApp) sent manually or via API, allowing filtering by period, service, user, API key or template. Ideal for audit, dispatch control and status tracking.
Request Example:
POST Get Session
Description: Returns the complete details of a messaging session (for example, from WhatsApp), including status, associated contact, channel and creation and update times. It is useful for consulting information about a specific conversation, validating service status or integrating session data into reports.
Request Example:
Response Example:
POST List Reviews
Description: Returns the list of feedbacks (ratings and observations) submitted by users in interactions with the chatbot. Allows filtering records by date range or by a specific session number, and also enables pagination of results.
Request Example:
Response Example:
CRM
POST List Objects
Description: Returns the records of a custom object created in the module CRM (e.g.: "Sales", "Customers", "Orders"). Allows applying filters, sorts and selection of specific fields, making it possible to build dynamic reports and queries.
Request Example:
Response Example:
POST Create Object
Description: Creates a new record in a CRM object (such as "Sales", "Customers" or "Orders"), providing the corresponding fields and values. The system performs automatic validation of required fields defined in the object configuration.
Request Example:
Response Example:
POST Edit Object
Description: Removes a specific record from a CRM object (such as "sales", "customers", "orders" etc.). Deletion is done based on the record ID, and not on the object ID or CRM structure.
Request Example:
Response Example:
POST Delete Object
Description:
Removes a specific record from a custom object created in the CRM module (e.g.: "Sales", "Customers", "Orders").
Deletion is done by providing the entity name (apiName) and the unique identifier (ID) of the desired record.
Request Example:
Response Example:
Contact Center
POST List Departments
Description: Returns a paginated list of active and inactive departments registered in the Contact Center. This endpoint is useful to query the name and ID of departments, which can be used in other integrations (such as ticket routing, attendances, among others).
Request Example:
Response Example:
POST List Service Groups
Description: Returns a paginated list of attendance groups linked to specific departments. Attendance groups organize operators and schedules, allowing the definition of rules and service queues.
Request Example:
Response Example:
POST List Specialties
Description: Returns a list of specializations (or subdivisions) linked to a specific attendance group. Each specialization represents an area, locality or type of service within an attendance group.
Request Example:
Response Example:
POST List Subspecialties
Description: Returns a list of subspecialties associated with a specific specialization (or group of specializations). Each subspecialty represents a more detailed subdivision within a specialization — such as a neighborhood, sector or service category.
Request Example:
Response Example:
POST List Areas
Description: Returns a list of areas associated with a specific subspecialization. Areas represent operational or thematic subdivisions within a subspecialization — for example, sectors, types of service or specific service categories.
Request Example:
Response Example:
POST List Subareas
Description: This endpoint returns the list of subareas associated with a specific area. Subareas represent subdivisions within a registered area.
Request Example:
Response Example:
POST List Service Schedules
Description: Returns the list of opening hours for a specific attendance group, filtering by attendance group, specialization, subspecialization, area and subarea.
Request Example:
Response Example:
POST List Service Schedule Exceptions
Description: Returns the exceptions of the registered opening hours for a given group, specialty, subspecialty, area and subarea.
These exceptions represent specific changes to the normal operating hours, such as holidays, maintenance or specific events that modify the standard availability.
Request Example:
Response Example:
Pulse
POST Create App Session
Description: This route creates a app session, allowing the system to recognize and authenticate an app that is connecting to the TatoDesk API.
Request Example:
Response Example:
POST Register event
Description: This route registers custom events related to an app session in TatoDesk. It is used to track user actions within the app — such as clicks, accesses, screen views, errors or any type of event you want to track.
Request Example:
Chatbot
POST List Journeys
Description: This route returns the list of chatbot journeys registered in the system. Each journey represents an automated support flow, and can be active or inactive.
Request Example:
Response Example:
Survey
POST Forms
Description: This route returns the full details of a survey form specific in the system. It is used to view the information configured in the form, such as name, description, image, colors and scale type.
Request Example:
Response Example:
POST Register form answers
Description: This request registers the answers provided by a user in a survey form. It sends both the form identification information and the set of filled questions and answers.
Request Example:
Response Example:
Last updated