Jump to Content
Home
Quickstart
API Reference
Changelog
API Reference
Home
Quickstart
API Reference
Changelog
The CustomField object
All
Pages
Start typing to search…
JUMP TO
Gorgias API
Introduction
Authentication
Requests
Errors
Pagination
Rate Limits
gorgias rest api
Account
The Account object
Retrieve your account
get
Create a setting
post
List settings
get
Update a setting
put
Customers
The Customer object
The CustomerChannel object
Create a customer
post
Delete customers
del
List customers
get
Delete a customer
del
Retrieve a customer
get
Update a customer
put
Merge two customers
put
Set customer data
put
Delete customer field value
del
Update customer field value
put
List customer field values
get
Update customer fields values
put
Custom Fields
The CustomField object
Create a custom field
post
List custom fields
get
Bulk update a list of custom fields
put
Retrieve a custom field
get
Update a custom field
put
Events
The Event object
Retrieve an event
get
List events
get
Files
The File object
Upload files
post
Download a file
get
Integrations
The Integration object
The TicketHttpIntegration object
Create an integration
post
List integrations
get
Delete an integration
del
Retrieve an integration
get
Update an integration
put
Jobs
The Job object
Create a job
post
List jobs
get
Cancel a job
del
Retrieve a job
get
Update a job
put
Macros
The Macro object
The MacroAction object
Create a macro
post
List macros
get
Delete a macro
del
Retrieve a macro
get
Update a macro
put
Archive macros
put
Unarchive macros
put
Reporting Statistics
Retrieve a statistic
post
Rules
The Rule object
Create a rule
post
List rules
get
Delete a rule
del
Retrieve a rule
get
Update a rule
put
Update rules' priorities
post
Satisfaction Surveys
The SatisfactionSurvey object
Create a survey
post
List surveys
get
Retrieve a survey
get
Update a survey
put
Search
Search for resources
post
Statistics
The Statistic object
Retrieve a statistic
post
Download a statistic
post
Tags
The Tag object
Create a tag
post
Delete tags
del
List tags
get
Delete a tag
del
Retrieve a tag
get
Update a tag
put
Merge tags
put
Teams
The Team object
Create a team
post
List teams
get
Delete a team
del
Retrieve a team
get
Update a team
put
Tickets
The Ticket object
Create a ticket
post
List tickets
get
Delete a ticket
del
Retrieve a ticket
get
Update a ticket
put
Add ticket tags
post
Remove ticket tags
del
List ticket tags
get
Set ticket tags
put
Delete ticket field value
del
Update ticket field value
put
List ticket field values
get
Update ticket fields values
put
Ticket Messages
The TicketMessage object
Create a message
post
List messages of a ticket
get
Delete a message
del
Retrieve a message
get
Update a message
put
List messages
get
Users
The User object
Create a user
post
List users
get
Delete a user
del
Retrieve a user
get
Update a user
put
Views
The View object
Create a view
post
List views
get
Delete a view
del
Retrieve a view
get
Update a view
put
List view's items
get
Search for view's items
put
Voice Calls
The VoiceCall object
Retrieve a voice call
get
List voice calls
get
Voice Call Recordings
The VoiceCallRecording object
Delete a voice call recording
del
Retrieve a voice call recording
get
List voice call recordings
get
Voice Call Events
The VoiceCallEvent object
Retrieve a voice call event
get
List voice call events
get
Widgets
The Widget object
Create a widget
post
List widgets
get
Delete a widget
del
Retrieve a widget
get
Update a widget
put
Powered by
The CustomField object
Ask AI
