Gorgias | Composio Docs

Overview

SLUG

GORGIAS

Description

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

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to openid,email,profile,offline,write:all

bearer_token

string

subdomain

stringRequired

Tools

List Teams

SLUG: GORGIAS_LIST_TEAMS

Lists teams in gorgias.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Add Ticket Tags

SLUG: GORGIAS_ADD_TICKET_TAGS

Adds tags to a ticket in gorgias.

Action Parameters

tag_ids

arrayRequired

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Account Setting

SLUG: GORGIAS_CREATE_ACCOUNT_SETTING

Creates a new account setting in gorgias.

Action Parameters

description

string

name

stringRequired

value

Required

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Customer

SLUG: GORGIAS_CREATE_CUSTOMER

Creates a new customer in gorgias.

Action Parameters

address

object

channels

array

data

object

string

external_id

string

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Team

SLUG: GORGIAS_CREATE_TEAM

Creates a new team in gorgias.

Action Parameters

decoration

object

description

string

members

array

name

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create Ticket

SLUG: GORGIAS_CREATE_TICKET

Creates a new ticket in gorgias.

Action Parameters

assignee_team_id

integer

assignee_user_id

integer

channel

string

customer_id

integerRequired

external_id

string

language

string

messages

array

Delete Customer

SLUG: GORGIAS_DELETE_CUSTOMER

Deletes a specific customer from gorgias.

Action Parameters

customer_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Customers

SLUG: GORGIAS_DELETE_CUSTOMERS

Deletes multiple customers from gorgias.

Action Parameters

customer_ids

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Customer Field Value

SLUG: GORGIAS_DELETE_CUSTOMER_FIELD_VALUE

Deletes a specific field value for a customer in gorgias.

Action Parameters

customer_id

integerRequired

field_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Team

SLUG: GORGIAS_DELETE_TEAM

Deletes a specific team from gorgias.

Action Parameters

team_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Ticket

SLUG: GORGIAS_DELETE_TICKET

Deletes a specific ticket from gorgias.

Action Parameters

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete Ticket Field Value

SLUG: GORGIAS_DELETE_TICKET_FIELD_VALUE

Deletes a specific field value for a ticket in gorgias.

Action Parameters

field_id

integerRequired

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Account

SLUG: GORGIAS_GET_ACCOUNT

Retrieves your gorgias account information.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Customer

SLUG: GORGIAS_GET_CUSTOMER

Retrieves a specific customer from gorgias.

Action Parameters

customer_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Event

SLUG: GORGIAS_GET_EVENT

Retrieves a specific event from gorgias.

Action Parameters

event_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Team

SLUG: GORGIAS_GET_TEAM

Retrieves a specific team from gorgias.

Action Parameters

team_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Get Ticket

SLUG: GORGIAS_GET_TICKET

Retrieves a specific ticket from gorgias.

Action Parameters

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Account Settings

SLUG: GORGIAS_LIST_ACCOUNT_SETTINGS

Lists all account settings in gorgias.

Action Parameters

limit

integer

offset

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Customers

SLUG: GORGIAS_LIST_CUSTOMERS

Lists customers in gorgias with various filtering options.

Action Parameters

created_from

string

created_to

string

external_id

string

limit

integer

name

string

offset

integer

order_by

string

order_dir

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Customer Field Values

SLUG: GORGIAS_LIST_CUSTOMER_FIELD_VALUES

Lists all field values for a customer in gorgias.

Action Parameters

customer_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Events

SLUG: GORGIAS_LIST_EVENTS

Lists events in gorgias with various filtering options.

Action Parameters

context

string

created_from

string

created_to

string

limit

integer

object_id

integer

object_type

string

offset

integer

type

string

user_id

integer

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Tickets

SLUG: GORGIAS_LIST_TICKETS

Lists tickets in gorgias with various filtering options.

Action Parameters

assignee_team_id

integer

assignee_user_id

integer

channel

string

created_from

string

created_to

string

customer_id

integer

external_id

string

language

string

limit

integer

offset

integer

order_by

string

order_dir

string

priority

string

status

string

tag_id

integer

updated_from

string

updated_to

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Ticket Field Values

SLUG: GORGIAS_LIST_TICKET_FIELD_VALUES

Lists all field values for a ticket in gorgias.

Action Parameters

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List Ticket Tags

SLUG: GORGIAS_LIST_TICKET_TAGS

Lists all tags for a ticket in gorgias.

Action Parameters

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Merge Customers

SLUG: GORGIAS_MERGE_CUSTOMERS

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

Action Parameters

source_customer_id

integerRequired

target_customer_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Remove Ticket Tags

SLUG: GORGIAS_REMOVE_TICKET_TAGS

Removes tags from a ticket in gorgias.

Action Parameters

tag_ids

arrayRequired

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Set Customer Data

SLUG: GORGIAS_SET_CUSTOMER_DATA

Sets the complete data object for a customer in gorgias.

Action Parameters

customer_id

integerRequired

data

objectRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Set Ticket Tags

SLUG: GORGIAS_SET_TICKET_TAGS

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

Action Parameters

tag_ids

arrayRequired

ticket_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update Account Setting

SLUG: GORGIAS_UPDATE_ACCOUNT_SETTING

Updates an existing account setting in gorgias.

Action Parameters

description

string

setting_id

integerRequired

value

Required

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update Customer

SLUG: GORGIAS_UPDATE_CUSTOMER

Updates an existing customer in gorgias.

Action Parameters

address

object

channels

array

customer_id

integerRequired

data

object

string

external_id

string

name

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update Team

SLUG: GORGIAS_UPDATE_TEAM

Updates an existing team in gorgias.

Action Parameters

decoration

object

description

string

members

array

name

string

team_id

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update Ticket

SLUG: GORGIAS_UPDATE_TICKET

Updates an existing ticket in gorgias.

Action Parameters

assignee_team_id

integer

assignee_user_id

integer

customer_id

integer

external_id

string

language

string