Create a view

post

https://{domain}.gorgias.com/api/views

Body Params

decoration

object

Object describing how the view appears in our applications. Currently only supports emoji field that shows before the view's name.

fields

array of strings

Defaults to

List of object's attributes to be displayed in the UI of our applications.

fields

filters

string

The logic used to filter the items to be displayed in the view (as JavaScript code).

name

string

The name of the view.

order_by

string

Defaults to updated_datetime

Name of the object's attribute used to sort the items of the view.

order_dir

string

enum

Defaults to desc

Sort direction of the items displayed in the view. Options: asc or desc.

Allowed:

shared_with_teams

array of integers

length ≤ 100

shared_with_teams

shared_with_users

array of integers

length ≤ 100

shared_with_users

slug

string

required

DEPRECATED - URL-compatible name of the view.

type

string

enum

Defaults to ticket-list

Type of objects the view is applied on.

Allowed:

visibility

string

enum

Defaults to public

Visibility of the view.

Possible values are:

public: any user of your helpdesk can see it.
shared: users listed under shared_with_users attribute and teams listed under shared_with_teams attribute can see it. All admins and lead agents will see it as well, even if they are not explicitly listed in the shared_with_users attribute.
private: only the single user listed under shared_with_users attribute can see it.

Allowed:

Response

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created view.