# Gorgias

Gorgias is a helpdesk and live chat platform specializing in e-commerce, offering automated support, order management, and unified customer communication

- **Category:** crm
- **Auth:** API_KEY, OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `GORGIAS`
- **Version:** 20260211_00

## Tools

### Add Ticket Tags

**Slug:** `GORGIAS_ADD_TICKET_TAGS`

Adds tags to a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | List of tag IDs to add to the ticket |
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Account Setting

**Slug:** `GORGIAS_CREATE_ACCOUNT_SETTING`

Creates a new account setting in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the setting |
| `value` | string | Yes | The value of the setting |
| `description` | string | No | Description of the setting |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Customer

**Slug:** `GORGIAS_CREATE_CUSTOMER`

Creates a new customer in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Additional customer data |
| `name` | string | Yes | The customer's full name |
| `email` | string | No | The customer's email address |
| `address` | object | No | The customer's address information |
| `channels` | array | No | The customer's communication channels |
| `external_id` | string | No | External identifier for the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Team

**Slug:** `GORGIAS_CREATE_TEAM`

Creates a new team in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the team |
| `members` | array | No | The list of users within the team |
| `decoration` | object | No | Object describing how the team appears on the webpage |
| `description` | string | No | Longer description of the team |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ticket

**Slug:** `GORGIAS_CREATE_TICKET`

Creates a new ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `via` | string | No | How the ticket was created |
| `meta` | object | No | Extra metadata about the ticket |
| `tags` | array | No | List of tag IDs to apply to the ticket |
| `status` | string | No | The status of the ticket |
| `channel` | string | No | The channel of the ticket (email, chat, etc.) |
| `subject` | string | No | The subject of the ticket |
| `language` | string | No | The language of the ticket |
| `messages` | array | No | Messages to add to the ticket |
| `priority` | string | No | The priority of the ticket |
| `customer_id` | integer | Yes | The ID of the customer for this ticket |
| `external_id` | string | No | External identifier for the ticket |
| `assignee_team_id` | integer | No | ID of the team to assign the ticket to |
| `assignee_user_id` | integer | No | ID of the user to assign the ticket to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer

**Slug:** `GORGIAS_DELETE_CUSTOMER`

Deletes a specific customer from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | The ID of the customer to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customer Field Value

**Slug:** `GORGIAS_DELETE_CUSTOMER_FIELD_VALUE`

Deletes a specific field value for a customer in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_id` | integer | Yes | The ID of the custom field |
| `customer_id` | integer | Yes | The ID of the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Customers

**Slug:** `GORGIAS_DELETE_CUSTOMERS`

Deletes multiple customers from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_ids` | array | Yes | List of customer IDs to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Team

**Slug:** `GORGIAS_DELETE_TEAM`

Deletes a specific team from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | integer | Yes | The ID of the team to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Ticket

**Slug:** `GORGIAS_DELETE_TICKET`

Deletes a specific ticket from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | The ID of the ticket to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Ticket Field Value

**Slug:** `GORGIAS_DELETE_TICKET_FIELD_VALUE`

Deletes a specific field value for a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `field_id` | integer | Yes | The ID of the custom field |
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account

**Slug:** `GORGIAS_GET_ACCOUNT`

Retrieves your Gorgias account information.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer

**Slug:** `GORGIAS_GET_CUSTOMER`

Retrieves a specific customer from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | The ID of the customer to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event

**Slug:** `GORGIAS_GET_EVENT`

Retrieves a specific event from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | integer | Yes | The ID of the event to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Team

**Slug:** `GORGIAS_GET_TEAM`

Retrieves a specific team from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | integer | Yes | The ID of the team to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ticket

**Slug:** `GORGIAS_GET_TICKET`

Retrieves a specific ticket from Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | The ID of the ticket to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Account Settings

**Slug:** `GORGIAS_LIST_ACCOUNT_SETTINGS`

Lists all account settings in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of settings to return (default: 20, max: 100) |
| `offset` | integer | No | Offset for pagination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customer Field Values

**Slug:** `GORGIAS_LIST_CUSTOMER_FIELD_VALUES`

Lists all field values for a customer in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `customer_id` | integer | Yes | The ID of the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Customers

**Slug:** `GORGIAS_LIST_CUSTOMERS`

Lists customers in Gorgias with various filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter by customer name |
| `email` | string | No | Filter by customer email |
| `limit` | integer | No | Number of customers to return (default: 20, max: 100) |
| `offset` | integer | No | Offset for pagination |
| `order_by` | string | No | Field to order by (e.g., 'created_datetime') |
| `order_dir` | string | No | Order direction ('asc' or 'desc') |
| `created_to` | string | No | Filter by creation date (ISO format) |
| `external_id` | string | No | Filter by external ID |
| `created_from` | string | No | Filter by creation date (ISO format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `GORGIAS_LIST_EVENTS`

Lists events in Gorgias with various filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter by event type |
| `limit` | integer | No | Number of events to return ( max: 100) |
| `offset` | integer | No | Offset for pagination |
| `context` | string | No | Filter by context UUID |
| `user_id` | integer | No | Filter by user ID |
| `object_id` | integer | No | Filter by object ID |
| `created_to` | string | No | Filter by creation date (ISO format) |
| `object_type` | string | No | Filter by object type |
| `created_from` | string | No | Filter by creation date (ISO format) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Teams

**Slug:** `GORGIAS_LIST_TEAMS`

Lists teams in Gorgias.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ticket Field Values

**Slug:** `GORGIAS_LIST_TICKET_FIELD_VALUES`

Lists all field values for a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tickets

**Slug:** `GORGIAS_LIST_TICKETS`

Lists tickets in Gorgias with various filtering options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of tickets to return (default: 20, max: 100) |
| `offset` | integer | No | Offset for pagination |
| `status` | string | No | Filter by ticket status |
| `tag_id` | integer | No | Filter by tag ID |
| `channel` | string | No | Filter by ticket channel |
| `language` | string | No | Filter by language |
| `order_by` | string | No | Field to order by (e.g., 'created_datetime') |
| `priority` | string | No | Filter by ticket priority |
| `order_dir` | string | No | Order direction ('asc' or 'desc') |
| `created_to` | string | No | Filter by creation date (ISO format) |
| `updated_to` | string | No | Filter by update date (ISO format) |
| `customer_id` | integer | No | Filter by customer ID |
| `external_id` | string | No | Filter by external ID |
| `created_from` | string | No | Filter by creation date (ISO format) |
| `updated_from` | string | No | Filter by update date (ISO format) |
| `assignee_team_id` | integer | No | Filter by assigned team ID |
| `assignee_user_id` | integer | No | Filter by assigned user ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ticket Tags

**Slug:** `GORGIAS_LIST_TICKET_TAGS`

Lists all tags for a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge Customers

**Slug:** `GORGIAS_MERGE_CUSTOMERS`

Merges two customers in Gorgias, combining their data and history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_customer_id` | integer | Yes | The ID of the source customer (will be merged into the target) |
| `target_customer_id` | integer | Yes | The ID of the target customer (will remain after merge) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Ticket Tags

**Slug:** `GORGIAS_REMOVE_TICKET_TAGS`

Removes tags from a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | List of tag IDs to remove from the ticket |
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Customer Data

**Slug:** `GORGIAS_SET_CUSTOMER_DATA`

Sets the complete data object for a customer in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | The complete data object to set for the customer |
| `customer_id` | integer | Yes | The ID of the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Ticket Tags

**Slug:** `GORGIAS_SET_TICKET_TAGS`

Sets the complete list of tags for a ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | List of tag IDs to set for the ticket |
| `ticket_id` | integer | Yes | The ID of the ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Setting

**Slug:** `GORGIAS_UPDATE_ACCOUNT_SETTING`

Updates an existing account setting in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value` | string | Yes | The new value of the setting |
| `setting_id` | integer | Yes | The ID of the setting to update |
| `description` | string | No | Updated description of the setting |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Customer

**Slug:** `GORGIAS_UPDATE_CUSTOMER`

Updates an existing customer in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | No | Additional customer data |
| `name` | string | No | The customer's full name |
| `email` | string | No | The customer's email address |
| `address` | object | No | The customer's address information |
| `channels` | array | No | The customer's communication channels |
| `customer_id` | integer | Yes | The ID of the customer to update |
| `external_id` | string | No | External identifier for the customer |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Team

**Slug:** `GORGIAS_UPDATE_TEAM`

Updates an existing team in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the team |
| `members` | array | No | The list of users within the team |
| `team_id` | integer | Yes | The ID of the team to update |
| `decoration` | object | No | Object describing how the team appears on the webpage |
| `description` | string | No | Longer description of the team |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ticket

**Slug:** `GORGIAS_UPDATE_TICKET`

Updates an existing ticket in Gorgias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `meta` | object | No | Extra metadata about the ticket |
| `status` | string | No | The status of the ticket |
| `subject` | string | No | The subject of the ticket |
| `language` | string | No | The language of the ticket |
| `priority` | string | No | The priority of the ticket |
| `ticket_id` | integer | Yes | The ID of the ticket to update |
| `customer_id` | integer | No | The ID of the customer for this ticket |
| `external_id` | string | No | External identifier for the ticket |
| `assignee_team_id` | integer | No | ID of the team to assign the ticket to |
| `assignee_user_id` | integer | No | ID of the user to assign the ticket to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |