Sign in Try for Free

Menu

Gorgias actions

Pick an action to see its parameters, request body and response fields.

119 actions

Account · 4

POSTCreate Account Setting/api/account/settingsCreate a setting GETGet Account/api/accountRetrieve your account GETList Account Settings/api/account/settingsList settings PUTUpdate Account Setting/api/account/settings/{id}Update a setting

Custom Fields · 5

POSTCreate Custom Field/api/custom-fieldsCreate a custom field GETGet Custom Field/api/custom-fields/{id}Retrieve a custom field GETList Custom Fields/api/custom-fieldsList custom fields PUTUpdate Custom Field/api/custom-fields/{id}Update a custom field PUTUpdate Custom Fields/api/custom-fieldsBulk update a list of custom fields

Customers · 12

POSTCreate Customer/api/customersCreate a customer DELETEDelete Customer/api/customers/{id}Delete a customer DELETEDelete Customer Custom Field Value/api/customers/{customer_id}/custom-fields/{id}Delete customer field value DELETEDelete Customers/api/customersDelete customers GETGet Customer/api/customers/{id}Retrieve a customer GETList Customer Custom Fields Values/api/customers/{customer_id}/custom-fieldsList customer field values GETList Customers/api/customersList customers PUTMerge Customers/api/customers/mergeMerge two customers PUTUpdate Customer/api/customers/{id}Update a customer PUTUpdate Customer Custom Field Value/api/customers/{customer_id}/custom-fields/{id}Update customer field value PUTUpdate Customer Custom Field Values/api/customers/{customer_id}/custom-fieldsUpdate customer fields values PUTUpdate Customer Data/api/customers/{customer_id}/dataSet customer data

Events · 2

GETGet Event/api/events/{id}Retrieve an event GETList Events/api/eventsList events

Files · 2

GETDownload File/api/{file_type}/download/{domain_hash}/{resource_name}Download a file POSTPost Api Upload/api/uploadUpload files

Generic Request · 5

DELETEGeneric Delete Request/{path}Generic DELETE Request GETGeneric Get Request/{path}Generic GET Request PATCHGeneric Patch Request/{path}Generic PATCH Request POSTGeneric Post Request/{path}Generic POST Request PUTGeneric Put Request/{path}Generic PUT Request

Integrations · 5

POSTCreate Integration/api/integrationsCreate an integration DELETEDelete Integration/api/integrations/{id}Delete an integration GETGet Integration/api/integrations/{id}Retrieve an integration GETList Integrations/api/integrationsList integrations PUTUpdate Integration/api/integrations/{id}Update an integration

Jobs · 5

DELETECancel Job/api/jobs/{id}Cancel a job POSTCreate Job/api/jobsCreate a job GETGet Job/api/jobs/{id}Retrieve a job GETList Jobs/api/jobsList jobs PUTUpdate Job/api/jobs/{id}Update a job

Macros · 7

PUTBulk Archive Macros/api/macros/archiveArchive macros PUTBulk Unarchive Macros/api/macros/unarchiveUnarchive macros POSTCreate Macro/api/macrosCreate a macro DELETEDelete Macro/api/macros/{id}Delete a macro GETGet Macro/api/macros/{id}Retrieve a macro GETList Macros/api/macrosList macros PUTUpdate Macro/api/macros/{id}Update a macro

Metric Cards · 3

POSTCreate Metric Card Feedback/api/metric-cards/{slug}/feedbackSubmit feedback on a metric card definition GETGet Metric Card/api/metric-cards/{slug}Retrieve a metric card by slug GETSearch Metric Cards/api/metric-cardsSearch metric cards

Reporting Statistics · 1

POSTGet Statistic/api/reporting/statsRetrieve a statistic

Rules · 6

POSTCreate Rule/api/rulesCreate a rule DELETEDelete Rule/api/rules/{id}Delete a rule GETGet Rule/api/rules/{id}Retrieve a rule GETList Rules/api/rulesList rules PUTUpdate Rule/api/rules/{id}Update a rule POSTUpdate Rules Priorities/api/rules/prioritiesUpdate rules' priorities

Satisfaction Surveys · 4

POSTCreate Satisfaction Survey/api/satisfaction-surveysCreate a survey GETGet Satisfaction Survey/api/satisfaction-surveys/{id}Retrieve a survey GETList Satisfaction Surveys/api/satisfaction-surveysList surveys PUTUpdate Satisfaction Survey/api/satisfaction-surveys/{id}Update a survey

Search · 1

POSTSearch/api/searchSearch for resources

Statistics · 2

POSTDownload Legacy Statistic/api/stats/{name}/downloadDownload a statistic POSTGet Legacy Statistic/api/stats/{name}Retrieve a statistic

Tags · 7

POSTCreate Tag/api/tagsCreate a tag DELETEDelete Tag/api/tags/{id}Delete a tag DELETEDelete Tags/api/tagsDelete tags GETGet Tag/api/tags/{id}Retrieve a tag GETList Tags/api/tagsList tags PUTMerge Tags/api/tags/{destination_tag_id}/mergeMerge tags PUTUpdate Tag/api/tags/{id}Update a tag

Teams · 5

POSTCreate Team/api/teamsCreate a team DELETEDelete Team/api/teams/{id}Delete a team GETGet Team/api/teams/{id}Retrieve a team GETList Teams/api/teamsList teams PUTUpdate Team/api/teams/{id}Update a team

Ticket Messages · 6

POSTCreate Ticket Message/api/tickets/{ticket_id}/messagesCreate a message DELETEDelete Ticket Message/api/tickets/{ticket_id}/messages/{id}Delete a message GETGet Ticket Message/api/tickets/{ticket_id}/messages/{id}Retrieve a message GETList Messages/api/messagesList messages GETList Ticket Messages/api/tickets/{ticket_id}/messagesList messages of a ticket PUTUpdate Ticket Message/api/tickets/{ticket_id}/messages/{id}Update a message

Tickets · 13

POSTCreate Ticket/api/ticketsCreate a ticket POSTCreate Ticket Tags/api/tickets/{ticket_id}/tagsAdd ticket tags DELETEDelete Ticket/api/tickets/{id}Delete a ticket DELETEDelete Ticket Custom Field/api/tickets/{ticket_id}/custom-fields/{id}Delete ticket field value DELETEDelete Ticket Tags/api/tickets/{ticket_id}/tagsRemove ticket tags GETGet Ticket/api/tickets/{id}Retrieve a ticket GETList Ticket Custom Fields/api/tickets/{ticket_id}/custom-fieldsList ticket field values GETList Ticket Tags/api/tickets/{ticket_id}/tagsList ticket tags GETList Tickets/api/ticketsList tickets PUTUpdate Ticket/api/tickets/{id}Update a ticket PUTUpdate Ticket Custom Field/api/tickets/{ticket_id}/custom-fields/{id}Update ticket field value PUTUpdate Ticket Custom Fields/api/tickets/{ticket_id}/custom-fieldsUpdate ticket fields values PUTUpdate Ticket Tags/api/tickets/{ticket_id}/tagsSet ticket tags

Users · 5

POSTCreate User/api/usersCreate a user DELETEDelete User/api/users/{id}Delete a user GETGet User/api/users/{id}Retrieve a user GETList Users/api/usersList users PUTUpdate User/api/users/{id}Update a user

Views · 7

POSTCreate View/api/viewsCreate a view DELETEDelete View/api/views/{id}Delete a view GETGet View/api/views/{id}Retrieve a view GETList View Items/api/views/{view_id}/itemsList view's items GETList Views/api/viewsList views PUTUpdate View/api/views/{id}Update a view PUTUpdate View Items/api/views/{view_id}/itemsSearch for view's items

Voice Call Events · 2

GETGet Voice Call Event/api/phone/voice-call-events/{id}Retrieve a voice call event GETList Voice Call Events/api/phone/voice-call-eventsList voice call events

Voice Call Recordings · 3

DELETEDelete Voice Call Recording/api/phone/voice-call-recordings/{id}Delete a voice call recording GETGet Voice Call Recording/api/phone/voice-call-recordings/{id}Retrieve a voice call recording GETList Voice Call Recordings/api/phone/voice-call-recordingsList voice call recordings

Voice Calls · 2

GETGet Voice Call/api/phone/voice-calls/{id}Retrieve a voice call GETList Voice Calls/api/phone/voice-callsList voice calls

Widgets · 5

POSTCreate Widget/api/widgetsCreate a widget DELETEDelete Widget/api/widgets/{id}Delete a widget GETGet Widget/api/widgets/{id}Retrieve a widget GETList Widgets/api/widgetsList widgets PUTUpdate Widget/api/widgets/{id}Update a widget

Gorgias actions — Documentation