Update Tag

Update a tag

PUT/api/tags/{id}

Use it in a workflow

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

Request

Path parameters

idintegerrequired

The ID of the tag to update.

Request body

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

namestring

Name of the tag. Tags' names are case sensitive.

descriptionstring

Short description of the tag.

decorationobject

Information related to the style of the tag.

colorstringrequired

The color of the tag (Hex color code).

json

{
  "name": "urgent",
  "description": "Mark a ticket as urgent",
  "decoration": {
    "color": "#F58D86"
  }
}

Response

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

idinteger

ID of the tag.

decorationobject

colorstring

The color of the tag (Hex color code).

descriptionstring

Short description of the tag.

namestring

Name of the tag. Tags' names are case sensitive.

usageinteger

Number of tickets this tag is associated with.

uristring

URI of the tag

created_datetimestring (date-time)

When the tag was created.

deleted_datetimestring (date-time)

When the tag was deleted.

json

{
  "id": 0,
  "decoration": {
    "color": "string"
  },
  "description": "string",
  "name": "string",
  "usage": 0,
  "uri": "string",
  "created_datetime": "2025-01-01T00:00:00Z",
  "deleted_datetime": "2025-01-01T00:00:00Z"
}

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

Was this page helpful?