Tidio

App · 20 actions

Manage Tidio contacts and tickets, read conversations, and watch contacts, tickets and messages.

Actions

ActionWhat it does
Create contactCreate contact.
Create contactsCreate contacts.
Create ticketCreate ticket.
Delete contactDelete contact.
Delete ticketDelete ticket.
Get contactGet contact.
Get projectGet project.
Get ticketGet ticket.
List contact propertiesList contact properties.
List contactsList contacts.
List departmentsList departments.
List messagesList messages.
List operatorsList operators.
List ticket custom fieldsList ticket custom fields.
List ticket tagsList ticket tags.
List ticketsList tickets.
List viewed pagesList viewed pages.
Reply to ticketAdd a reply or note to a ticket as a contact or operator.
Update contactUpdate contact.
Update ticketUpdate ticket.

Create contact

Create contact.

Inputs

Distinct IDdistinct_idtextRequired
ID of the contact in external system
Emailemailtext
Email address of the contact [RFC822]
Phonephonetext
Phone number of the contact
First namefirst_nametext
First name of the contact
Last namelast_nametext
Last name of the contact
Email consentemail_consenttext
This field indicates if contact agreed to newsletter subscriptionOne of: subscribed, unsubscribed.
Propertiespropertieslist
Properties.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e"
  }
}

Create contacts

Create contacts.

Inputs

ContactscontactslistRequired
Contacts.From 1 to 100.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Create ticket

Create ticket.

Inputs

Contact emailcontact_emailtextRequired
Email of contact person
SubjectsubjecttextRequired
Subject of ticket
Message contentmessage_contenttextRequired
First ticket message content
Assigned departmentassigned_department_idtext
ID of assigned Department. When not provided, then the General department is assigned as default.
Custom channel IDcustom_channel_idtext
ID of custom channel to attach to given ticket.
Tag IDstag_idslist
List of tag IDs to attach to the ticket.
Custom fieldscustom_fieldslist
Custom field values to set on the ticket

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 10000
  }
}

Delete contact

Delete contact.

Inputs

Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete ticket

Delete ticket.

Inputs

Ticketticket_idnumberRequired
Ticket ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get contact

Get contact.

Inputs

Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "a1b4ca4c-1108-4432-b256-1e4cf2bf6f9e"
  }
}

Get project

Get project.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get ticket

Get ticket.

Inputs

Ticketticket_idnumberRequired
Ticket ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 10000
  }
}

List contact properties

List contact properties.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List contacts

List contacts.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one
Emailemailtext
Filter contacts by email address

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List departments

List departments.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List messages

List messages.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one
Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List operators

List operators.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List ticket custom fields

List ticket custom fields.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": [
      {
        "id": "01HF8N4A2B3C4D5E6F7G8H9J0K",
        "is_required": false,
        "name": "Priority reason",
        "type": "text"
      },
      {
        "id": "01HF8N4A2B3C4D5E6F7G8H9J0L",
        "is_dynamic": false,
        "is_required": true,
        "name": "Category",
        "type": "dropdown_text",
        "values": [
          "billing",
          "shipping",
          "other"
        ]
      }
    ]
  }
}

List ticket tags

List ticket tags.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "data": [
      {
        "id": 1,
        "name": "billing"
      },
      {
        "id": 2,
        "name": "shipping"
      },
      {
        "id": 3,
        "name": "Z\u00fcrich"
      }
    ]
  }
}

List tickets

List tickets.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List viewed pages

List viewed pages.

Inputs

Cursorcursortext
Value from the previous page. Use null to fetch the first one
Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Reply to ticket

Add a reply or note to a ticket as a contact or operator.

Inputs

Ticketticket_idnumberRequired
Ticket ID.
Author typeauthor_typetextRequired
Who repliedOne of: contact, operator.
ContentcontenttextRequired
Message content
Operatoroperator_idtext
Operator id
Message typemessage_typetext
Determines visibility of messageOne of: public, internal.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "01HAVMVKF90KH3EC0HK2T6QYP6"
  }
}

Update contact

Update contact.

Inputs

Contactcontact_idtextRequired
Contact ID.
Emailemailtext
Email address of the contact [RFC822]
Phonephonetext
Phone number of the contact
First namefirst_nametext
First name of the contact
Last namelast_nametext
Last name of the contact
Email consentemail_consenttext
This field indicates if contact agreed to newsletter subscriptionOne of: subscribed, unsubscribed.
Propertiespropertieslist
Properties.
Distinct IDdistinct_idtext
ID of the contact in external system

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update ticket

Update ticket.

Inputs

Ticketticket_idnumberRequired
Ticket ID.
Statusstatustext
Ticket statusOne of: open, pending, solved.
Priorityprioritytext
Ticket priorityOne of: low, normal, urgent.
Tag IDstag_idslist
Replaces the ticket's full tag set with the supplied IDs. Empty array removes all tags.
Custom fieldscustom_fieldslist
Upserts the specified custom field values using merge semantics. Fields not in the payload are left unchanged. Send `value: null` to remove the stored value for a field.
Assign toassignee_typetext
Type of assignOne of: department, operator.
Assigneeassignee_idtext
ID of assigned type

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

On this page