Update View Items

Search for view's items

PUT/api/views/{view_id}/items

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Update View Items action (under Views).
Fill in the fields below, then reference the result from later steps as {{updateViewItems.response.data}}.

Request

Path parameters

view_idintegerrequired

This parameter should be set to 0.

Query parameters

cursorstring

Value indicating your position in the list of all the view's items. If omitted, the first items of the list will be returned.

directionstring | null

- `prev` returns items before the cursor. - `next` returns items after the cursor.

One ofprevnext

ignored_iteminteger

ID of an item to ignore in the list of returned items.

limitinteger

Maximum number of items to return.

Default 30

order_bystring

Attribute used to order views.

One ofcreated_datetime:asccreated_datetime:descupdated_datetime:ascupdated_datetime:desclast_message_datetime:asclast_message_datetime:desclast_received_message_datetime:asclast_received_message_datetime:descclosed_datetime:ascclosed_datetime:descsnooze_datetime:ascsnooze_datetime:descpriority:ascpriority:desc

Request body

Enter the body as JSON in the step's Body field.

viewobject

categorystring | null

Category is an internal, read-only field used to identify system and user views.Example of system views: Trash or Spam. System views cannot be deleted.

Default "user"

fieldsarray<string>

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

Default []

filtersstring

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

order_bystring

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

Default "updated_datetime"

order_dirstring

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

One ofascdescDefault "desc"

searchstring | null

Text used to search for items matching the query.

typestring

Type of objects the view is applied on.

One ofticket-listDefault "ticket-list"

json

{
  "view": {
    "id": 123,
    "category": "user",
    "created_datetime": "2019-11-23T15:59:41.966927",
    "deactivated_datetime": "2020-01-30T11:04:34.345123",
    "decoration": {
      "emoji": "🙏"
    },
    "fields": [
      "id",
      "details",
      "tags"
    ],
    "filters": "eq(ticket.assignee_user.id, '{{current_user.id}}') && eq(ticket.status, 'open')",
    "name": "My view",
    "order_by": "updated_datetime",
    "order_dir": "desc",
    "search": "where is my order?",
    "slug": "my-tickets",
    "type": "ticket-list"
  }
}

Response

Returns 202 with an object. Read it in later steps with {{updateViewItems.response.data.<field>}}.

dataarray<object>

idinteger

ID of the object

uristring

URI of the object (auto-generated)

external_idstring | null

Another ID for the ticket. Can be set freely.

languagestring | null

The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the client's messages on this ticket. This field is automatically generated by Gorgias if empty.

statusstring

Ticket status is used for managing the lifecycle of the ticket

Default "open"

prioritystring

Indicates the importance of the ticket.

Default "normal"

channelstring

The channel used to communicate with the user on this ticket.If not specified, it will be filled with the channel of the first [TicketMessage](#TicketMessage-object) of this ticket.

viastring

Indicates via which means this ticket was created. If not specified, it will be filled with the `via` value of the first [TicketMessage](#TicketMessage-object) of this ticket.For example, a ticket of channel `email` could have been created through the API because of an integration; the `via` would then be `api`.

from_agentboolean

Indicates whether the ticket has been created because a user or a customer sent a message. If not specified, it will be filled with the `from_agent` value of the first [TicketMessage](#TicketMessage-object) of this ticket.

customerobjectrequired6 fields

The user who is requesting something in this ticket.

assignee_userobject7 fields

The agent assigned to this ticket.

assignee_teamobject3 fields

The team assigned to this ticket.

subjectstring | null

The subject of the ticket. If not specified, it will be filled with the subject of the first [TicketMessage](#TicketMessage-object) of this ticket.

excerptstring

integrationsarray<object>

metanull

Extra metadatas about the ticket.

tagsarray<object>4 fields

The tags associated with the ticket.

messages_countinteger

is_unreadboolean

Default false

spamboolean | null

Indicates whether the ticket is considered as spam or not.

Default false

created_datetimestring | null

When the ticket was created.

opened_datetimestring | null

When the ticket was opened for the first time.

last_received_message_datetimestring | null

When a message was received for the last time.

last_message_datetimestring | null

When a message was received or sent for the last time.

updated_datetimestring | null

When the ticket was updated for the last time.

closed_datetimestring | null

When the ticket was closed for the last time.

snooze_datetimestring | null

When the ticket will be automatically re-open. Set if an agent wants to come back to this ticket later

trashed_datetimestring | null

When the ticket was moved to the trash for the last time.

last_sent_message_not_deliveredboolean | null

metaany

json

{
  "data": {
    "subject": "Refund request",
    "meta": {},
    "requester": {
      "id": 7,
      "email": "sender@gorgias.io",
      "name": "Sender Doe",
      "firstname": "Sender",
      "lastname": "Doe"
    },
    "customer": {
      "id": 7,
      "email": "sender@gorgias.io",
      "name": "Sender Doe",
      "firstname": "Sender",
      "lastname": "Doe"
    },
    "assignee_user": {
      "id": 4,
      "email": "agent-smith@gorgias.io",
      "name": "John Smith",
      "firstname": "John",
      "lastname": "Smith"
    },
    "assignee_user_id": 4,
    "assignee_team": {
      "id": 8,
      "name": "Tech team",
      "decoration": {
        "emoji": {
          "colons": ":wink:",
          "emoticons": [
            ";)",
            ";-)"
          ],
          "id": "wink",
          "name": "Winking Face",
          "native": "😉",
          "skin": null,
          "unified": "1f609"
        }
      }
    },
    "assignee_team_id": 8,
    "tags": [
      {
        "id": 5,
        "name": "refund",
        "uri": "https://gorgias.gorgias.io/api/tags/5/"
      }
    ],
    "custom_fields": {
      "6": {
        "id": 6,
        "value": "Some value"
      }
    },
    "language": "fr"
  },
  "meta": {
    "current_cursor": "MTU5MzE2NDMwMDAwMDAwMC1mYWxzZQ==",
    "next_items": "/api/views/10/items/?direction=next&ignored_item=1781&cursor=MTU5MzA5ODYyNDAwMDAwMC1mYWxzZQ%3D%3D",
    "prev_items": "/api/views/10/items/?direction=prev&cursor=MTU5MzEyMTk4MTAwMDAwMC1mYWxzZQ%3D%3D&ignored_item=1743"
  }
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?