# Gladly

> Work with Gladly, the customer service platform built around people: find and update customers, read, assign, close and note conversations, reply and send texts and emails, manage tasks and search answers, and start workflows when conversations, messages, customers or tasks change.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/gladly

## Actions

### Add customer activity

Put an activity from another system (an order issue, a survey answer, an email it sent) on a customer's timeline for agents to see.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.
- Title (`title`, text, required): The first, highlighted line, such as Order 1001 delayed.
- Details (`body`, text): The rest of the card. Plain text or simple HTML.
- Icon (`activity_type`, text): Which icon the card shows. Defaults to Issue. One of: `ISSUE`, `EMAIL`, `SMS` (Text message), `SURVEY`. Default: `ISSUE`.
- Source (`source_name`, text): The system it came from, such as Shopify.
- Link (`link_url`, text): A web address to show at the bottom of the card.
- Link text (`link_text`, text): The link's label, such as View order.
- Happened at (`occurred_at`, date and time): When it happened, which places it on the timeline (within the last year). Leave empty for now.
- Show expanded (`expand_by_default`, true/false): Show the card opened up on the timeline. Default: `false`.

**Outputs**

- `activity` (object): The activity, as it is on the timeline
- `activity_id` (text): The activity's id

**Example output**

```json
{
  "activity": {
    "content": {
      "activityType": "ISSUE",
      "body": "Order 1001 is delayed by two days.",
      "sourceName": "Shopify",
      "title": "Order 1001 delayed",
      "type": "CUSTOMER_ACTIVITY"
    },
    "conversation_id": "",
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "from": "",
    "id": "Qm1X2b3cR4eF5g6H7i8J9k",
    "initiator_id": "",
    "initiator_type": "API",
    "responder_id": "",
    "responder_type": "",
    "subject": "",
    "text": "Order 1001 is delayed by two days.",
    "timestamp": "2026-03-02T00:10:00.000Z",
    "to": [],
    "type": "CUSTOMER_ACTIVITY"
  },
  "activity_id": "Qm1X2b3cR4eF5g6H7i8J9k"
}
```

### Add note

Add an internal note to a conversation. Customers never see notes.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's id, from 'List conversations', a trigger or an earlier step.
- Note (`note`, text, required): What the note says. Plain text or simple HTML.

**Outputs**

- `conversation_id` (text): The conversation the note is on
- `note` (text): What the note says
- `note_id` (text): The new note's id, or empty if Gladly did not say

**Example output**

```json
{
  "conversation_id": "HXRqKC5GSV-jAlq0-sxYTA",
  "note": "Customer asked about the loyalty program.",
  "note_id": "UAAAlBdOQwGl7mzqQUfVow"
}
```

### Add task comment

Comment on an open task, as the connected Gladly user or as the agent you choose.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task', 'List tasks' or a trigger.
- Comment (`comment`, text, required): What the comment says.
- Agent (`agent_id`, text): Who the comment is from. Leave empty for the connected user.

**Outputs**

- `comment` (object): A comment on a task
- `comment_id` (text): The new comment's id

**Example output**

```json
{
  "comment": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "comment": "Left a voicemail.",
    "created_at": "",
    "id": "pOVVdzweSumI4bFxjlT8LA",
    "task_id": "dzweSumI4bFxjlT8LApOVV"
  },
  "comment_id": "pOVVdzweSumI4bFxjlT8LA"
}
```

### Create customer

Add a customer profile with an email address, a phone number or both. Gladly refuses an address or number another customer has.

**Inputs**

- Name (`name`, text): The customer's full name.
- Email (`email`, text): Their email address. Gladly needs an email or a phone number for a new customer, and no two customers may share one.
- Phone (`phone`, text): Their phone number with its country code, such as +14155550100.
- Phone type (`phone_type`, text): What kind of number it is. One of: `MOBILE`, `HOME`, `OFFICE`.
- Text messages (`sms_preference`, text): Whether Gladly may text this number. Texts go only to a number set to On. One of: `ON` (On: texts may be sent), `OFF` (Off: no texts for now), `FORBIDDEN` (Forbidden: never text this number).
- Street address (`address`, text): The customer's street address.
- External customer ID (`external_customer_id`, text): The customer's id in your own system, for a lookup adapter installed before May 2021.
- Custom attributes (`custom_attributes`, object): Your organization's own customer fields, such as {"membershipTier": "gold"}. Only the names given change.
- Customer ID (`customer_id`, text): An id of your own for the customer (letters, digits, - and _). Leave empty and one is made.

**Outputs**

- `customer` (object): A Gladly customer profile
- `customer_id` (text): The new customer's id

**Example output**

```json
{
  "customer": {
    "address": "563 Rigoberto Station Apt. 197",
    "created_at": "2026-02-21T07:15:18.072Z",
    "custom_attributes": {
      "membershipTier": "gold"
    },
    "email": "martha.williams@example.com",
    "emails": [
      {
        "address": "martha.williams@example.com",
        "primary": true
      }
    ],
    "external_customer_id": "",
    "external_customer_ids": {},
    "id": "OOrlNMXeS72gs_WEX2TtMg",
    "image_url": "",
    "name": "Martha Williams",
    "phone": "+17244895501",
    "phones": [
      {
        "extension": "",
        "number": "+17244895501",
        "primary": true,
        "sms_preference": "ON",
        "type": "MOBILE"
      }
    ],
    "updated_at": "2026-02-21T19:50:23.486Z"
  },
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg"
}
```

### Create task

Add a follow-up task for a customer, due at a set time and assigned to an inbox, and to an agent if you choose one.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.
- Task (`description`, text, required): What needs doing, such as Call back about the refund.
- Due (`due_at`, date and time, required): When it is due. It must be in the future.
- Inbox (`inbox_id`, text, required): The inbox the task goes to.
- Agent (`agent_id`, text): The agent to give it to, who must belong to the inbox.
- Topics (`topic_ids`, list): Topics to label it with. A topic that only groups others can't be used.

**Outputs**

- `task` (object): A Gladly task: follow-up work for a customer
- `task_id` (text): The new task's id

**Example output**

```json
{
  "task": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "body": "Call the customer back about their booking",
    "body_text": "Call the customer back about their booking",
    "created_at": "2026-03-02T04:30:12.070Z",
    "created_by_id": "",
    "created_by_type": "API",
    "custom_attributes": [],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "due_at": "2026-03-15T06:13:00.000Z",
    "id": "dzweSumI4bFxjlT8LApOVV",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "OPEN",
    "topic_ids": []
  },
  "task_id": "dzweSumI4bFxjlT8LApOVV"
}
```

### Delete customer

Delete a customer profile and its timeline. Gladly refuses while the customer has an open or waiting conversation.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.

**Outputs**

- `customer_id` (text): The customer deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
  "deleted": true
}
```

### Find answers

Find answers in Gladly's knowledge base by words in their name or description, most recently changed first.

**Inputs**

- Words to find (`search`, text): Every word must be in the answer's name or description. Leave empty for every answer.
- Language (`language`, text): Only answers written in this language, such as en-us.
- Most to return (`limit`, number): How many answers to return, 1 to 100. From 1 to 100. Default: `25`.

**Outputs**

- `answers` (list): The answers found
- `count` (number): How many there are
- `total_matches` (number): How many answers matched, before the limit

**Example output**

```json
{
  "answers": [
    {
      "audience_ids": [],
      "available_contents": {
        "en-us": [
          "reference",
          "public"
        ]
      },
      "created_at": "2026-01-13T15:16:29.894Z",
      "description": "Steps for a customer locked out of their account",
      "id": "1grfSzATQLa334VDLCWc4A",
      "languages": [
        "en-us"
      ],
      "name": "How to reset your password",
      "updated_at": "2026-06-13T15:16:29.894Z"
    }
  ],
  "count": 1,
  "total_matches": 1
}
```

### Find customers

Find customer profiles by email address, phone number or external customer id. Returns up to 50, most recently changed first.

**Inputs**

- Find by (`find_by`, text): What to search on. Defaults to email address. One of: `email` (Email address), `phone` (Phone number), `external_id` (External customer ID). Default: `email`.
- Search for (`value`, text, required): The email address, phone number (with its country code, such as +14155550100) or external id to find.

**Outputs**

- `count` (number): How many there are
- `customer_id` (text): The first customer's id, or empty if none
- `customers` (list): The customers found
- `found` (true/false): Whether any customer was found

**Example output**

```json
{
  "count": 1,
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
  "customers": [
    {
      "address": "563 Rigoberto Station Apt. 197",
      "created_at": "2026-02-21T07:15:18.072Z",
      "custom_attributes": {
        "membershipTier": "gold"
      },
      "email": "martha.williams@example.com",
      "emails": [
        {
          "address": "martha.williams@example.com",
          "primary": true
        }
      ],
      "external_customer_id": "",
      "external_customer_ids": {},
      "id": "OOrlNMXeS72gs_WEX2TtMg",
      "image_url": "",
      "name": "Martha Williams",
      "phone": "+17244895501",
      "phones": [
        {
          "extension": "",
          "number": "+17244895501",
          "primary": true,
          "sms_preference": "ON",
          "type": "MOBILE"
        }
      ],
      "updated_at": "2026-02-21T19:50:23.486Z"
    }
  ],
  "found": true
}
```

### Get answer

Get the words of a knowledge-base answer in one language and form: reference, public, email or messaging.

**Inputs**

- Answer (`answer_id`, text, required): The answer. Pick one, or give its id from 'Find answers'.
- Language (`language`, text): Such as en-us. Leave empty for English, or else the first language it is written in.
- Form (`content_type`, text): Which version to read. Leave empty for the first written, in the order listed. One of: `reference` (Reference (for agents)), `public` (Public (help center)), `email`, `messaging` (Messaging (chat and text)).

**Outputs**

- `answer` (object): An answer in Gladly's knowledge base
- `body_html` (text): The answer's words as HTML
- `body_text` (text): The answer's words as plain text
- `content_type` (text): The form read: reference, public, email or messaging
- `internal` (true/false): Whether it is for agents only, for a reference answer
- `language` (text): The language read, such as en-us
- `subject` (text): The subject line, for an email answer
- `title` (text): The title, for a public answer

**Example output**

```json
{
  "answer": {
    "audience_ids": [],
    "available_contents": {
      "en-us": [
        "reference",
        "public"
      ]
    },
    "created_at": "2026-01-13T15:16:29.894Z",
    "description": "Steps for a customer locked out of their account",
    "id": "1grfSzATQLa334VDLCWc4A",
    "languages": [
      "en-us"
    ],
    "name": "How to reset your password",
    "updated_at": "2026-06-13T15:16:29.894Z"
  },
  "body_html": "<div>Send them the reset link from Settings.</div>",
  "body_text": "Send them the reset link from Settings.",
  "content_type": "reference",
  "internal": true,
  "language": "en-us",
  "subject": "",
  "title": ""
}
```

### Get conversation

Get a conversation's status, inbox, agent, topics and when it started and closed.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's id, from 'List conversations', a trigger or an earlier step.

**Outputs**

- `conversation` (object): A Gladly conversation

**Example output**

```json
{
  "conversation": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "closed_at": "",
    "created_at": "2026-03-02T00:10:00.000Z",
    "custom_attributes": [
      {
        "id": "cEBkE90eQHObfcsnrm60Tg",
        "value": "UPS"
      }
    ],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "id": "HXRqKC5GSV-jAlq0-sxYTA",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "OPEN",
    "topic_ids": [
      "_DZTz4I0Qsq9YXxeXwufMg"
    ]
  }
}
```

### Get customer

Get a customer's profile: name, email addresses, phone numbers and custom attributes.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.

**Outputs**

- `customer` (object): A Gladly customer profile

**Example output**

```json
{
  "customer": {
    "address": "563 Rigoberto Station Apt. 197",
    "created_at": "2026-02-21T07:15:18.072Z",
    "custom_attributes": {
      "membershipTier": "gold"
    },
    "email": "martha.williams@example.com",
    "emails": [
      {
        "address": "martha.williams@example.com",
        "primary": true
      }
    ],
    "external_customer_id": "",
    "external_customer_ids": {},
    "id": "OOrlNMXeS72gs_WEX2TtMg",
    "image_url": "",
    "name": "Martha Williams",
    "phone": "+17244895501",
    "phones": [
      {
        "extension": "",
        "number": "+17244895501",
        "primary": true,
        "sms_preference": "ON",
        "type": "MOBILE"
      }
    ],
    "updated_at": "2026-02-21T19:50:23.486Z"
  }
}
```

### Get task

Get a task: what it says, its status, when it is due and who has it.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task', 'List tasks' or a trigger.

**Outputs**

- `task` (object): A Gladly task: follow-up work for a customer

**Example output**

```json
{
  "task": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "body": "Call the customer back about their booking",
    "body_text": "Call the customer back about their booking",
    "created_at": "2026-03-02T04:30:12.070Z",
    "created_by_id": "",
    "created_by_type": "API",
    "custom_attributes": [],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "due_at": "2026-03-15T06:13:00.000Z",
    "id": "dzweSumI4bFxjlT8LApOVV",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "OPEN",
    "topic_ids": []
  }
}
```

### List agents

List the organization's agents with their ids and email addresses.

**Inputs**

- Name or email contains (`search`, text): Only agents whose name or email has this text.

**Outputs**

- `agents` (list): The agents
- `count` (number): How many there are

**Example output**

```json
{
  "agents": [
    {
      "email": "amy.agent@example.com",
      "id": "sHuXx-U3QqOmhvFusJGeBw",
      "name": "Amy Agent"
    }
  ],
  "count": 1
}
```

### List conversation items

Read a conversation's timeline, oldest first: emails, texts, chats, calls, notes and status changes, each with its text.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's id, from 'List conversations', a trigger or an earlier step.

**Outputs**

- `count` (number): How many there are
- `items` (list): The timeline, oldest first
- `latest_item_id` (text): The newest item's id, or empty

**Example output**

```json
{
  "count": 1,
  "items": [
    {
      "content": {
        "content": "I haven't received my order yet. Can you check on the status?",
        "from": "+17244895501",
        "to": "+12149897676",
        "type": "SMS"
      },
      "conversation_id": "HXRqKC5GSV-jAlq0-sxYTA",
      "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
      "from": "+17244895501",
      "id": "pOVVdzweSumI4bFxjlT8LA",
      "initiator_id": "OOrlNMXeS72gs_WEX2TtMg",
      "initiator_type": "CUSTOMER",
      "responder_id": "",
      "responder_type": "",
      "subject": "",
      "text": "I haven't received my order yet. Can you check on the status?",
      "timestamp": "2026-03-02T00:10:00.000Z",
      "to": [
        "+12149897676"
      ],
      "type": "SMS"
    }
  ],
  "latest_item_id": "pOVVdzweSumI4bFxjlT8LA"
}
```

### List conversations

List a customer's conversations, newest first, with their status, inbox, agent and topics. Gladly returns up to 100.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.
- Status (`status`, text): Only conversations with this status. Defaults to any. One of: `ANY` (Any status), `OPEN`, `WAITING`, `CLOSED`. Default: `ANY`.

**Outputs**

- `conversations` (list): The conversations, newest first
- `count` (number): How many there are
- `latest_conversation_id` (text): The newest conversation's id, or empty

**Example output**

```json
{
  "conversations": [
    {
      "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
      "closed_at": "",
      "created_at": "2026-03-02T00:10:00.000Z",
      "custom_attributes": [
        {
          "id": "cEBkE90eQHObfcsnrm60Tg",
          "value": "UPS"
        }
      ],
      "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
      "id": "HXRqKC5GSV-jAlq0-sxYTA",
      "inbox_id": "E1nArq1uQAees_DogHB0MA",
      "status": "OPEN",
      "topic_ids": [
        "_DZTz4I0Qsq9YXxeXwufMg"
      ]
    }
  ],
  "count": 1,
  "latest_conversation_id": "HXRqKC5GSV-jAlq0-sxYTA"
}
```

### List inboxes

List the organization's inboxes with their ids.

**Inputs**

- Include turned-off inboxes (`include_disabled`, true/false): Also list inboxes that are turned off. Default: `false`.

**Outputs**

- `count` (number): How many there are
- `inboxes` (list): The inboxes

**Example output**

```json
{
  "count": 1,
  "inboxes": [
    {
      "disabled": false,
      "id": "E1nArq1uQAees_DogHB0MA",
      "name": "Email Inbox"
    }
  ]
}
```

### List tasks

List a customer's tasks, newest first. Gladly returns up to 2,000.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.
- Status (`status`, text): Only tasks with this status. Defaults to any. One of: `ANY` (Any status), `OPEN`, `CLOSED`. Default: `ANY`.

**Outputs**

- `count` (number): How many there are
- `tasks` (list): The tasks, newest first

**Example output**

```json
{
  "count": 1,
  "tasks": [
    {
      "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
      "body": "Call the customer back about their booking",
      "body_text": "Call the customer back about their booking",
      "created_at": "2026-03-02T04:30:12.070Z",
      "created_by_id": "",
      "created_by_type": "API",
      "custom_attributes": [],
      "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
      "due_at": "2026-03-15T06:13:00.000Z",
      "id": "dzweSumI4bFxjlT8LApOVV",
      "inbox_id": "E1nArq1uQAees_DogHB0MA",
      "status": "OPEN",
      "topic_ids": []
    }
  ]
}
```

### List topics

List the topics conversations and tasks can be labelled with, with their full paths.

**Inputs**

- Name contains (`search`, text): Only topics whose name (or a parent's) has this text.
- Include retired topics (`include_disabled`, true/false): Also list topics that can no longer be applied. Default: `false`.

**Outputs**

- `count` (number): How many there are
- `topics` (list): The topics

**Example output**

```json
{
  "count": 1,
  "topics": [
    {
      "disabled": false,
      "has_subtopics": false,
      "id": "8eiDakrnTgKa3HIxtgV5OA",
      "name": "Damaged Merchandise",
      "parent_id": "Z_Oto7j-Sy2DlQdnZBDdDw",
      "path": "Order Return > Damaged Merchandise"
    }
  ]
}
```

### Reply to message

Reply to a customer's message on the channel it came in on: email, chat, text, WhatsApp, Facebook or Instagram. The conversation must be open.

**Inputs**

- Message ID (`message_id`, text, required): The id of the customer's message, from 'Message received' or 'List conversation items'.
- Reply (`reply`, text, required): What to say. Line breaks are kept.

**Outputs**

- `channel` (text): The channel the reply went on, such as EMAIL or SMS
- `conversation_id` (text): The conversation it is part of
- `customer_id` (text): The customer replied to
- `message_id` (text): The message replied to
- `replied` (true/false): Always true once Gladly took the reply
- `reply_id` (text): The reply's id, or empty if Gladly did not say

**Example output**

```json
{
  "channel": "SMS",
  "conversation_id": "HXRqKC5GSV-jAlq0-sxYTA",
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
  "message_id": "pOVVdzweSumI4bFxjlT8LA",
  "replied": true,
  "reply_id": "kq8b2RHjQmO1dD8wJx0ZQg"
}
```

### Send email

Email a customer from one of your Gladly support addresses. A customer is added if none has the address. The email is not part of a conversation.

**Inputs**

- To (`to`, text, required): The customer's email address.
- Customer name (`to_name`, text): Their name, used if Gladly adds them as a new customer.
- Subject (`subject`, text, required): The subject line, under 1,000 characters.
- Message (`message`, text, required): What to say. Line breaks are kept.
- From (`sender`, text): The Gladly support address to send from. Leave empty for your first one.

**Outputs**

- `customer_id` (text): The customer emailed
- `from` (text): The address it was sent from
- `message_id` (text): The email's id on the customer's timeline
- `sent` (true/false): Always true once Gladly took the email
- `to` (text): The address emailed

**Example output**

```json
{
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
  "from": "support@example.com",
  "message_id": "Z9bWl0fRQ7-0p4vVJ5d0zA",
  "sent": true,
  "to": "martha.williams@example.com"
}
```

### Send text message

Text a customer by their mobile number, from one of your Gladly numbers. A customer is added if none has the number.

**Inputs**

- To (`to`, text, required): The customer's mobile number with its country code, such as +14155550100.
- Message (`message`, text, required): What to say. Long texts are sent and paid for in parts.
- From (`sender`, text): The Gladly number to send from. Leave empty for your first text messaging number.

**Outputs**

- `conversation_id` (text): The conversation it joined, or empty if not known yet
- `customer_id` (text): The customer texted
- `from` (text): The number it was sent from
- `message_id` (text): The text's id on the customer's timeline
- `sent` (true/false): Always true once Gladly took the text
- `to` (text): The number texted

**Example output**

```json
{
  "conversation_id": "HXRqKC5GSV-jAlq0-sxYTA",
  "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
  "from": "+12149897676",
  "message_id": "pOVVdzweSumI4bFxjlT8LA",
  "sent": true,
  "to": "+17244895501"
}
```

### Update conversation

Close or reopen a conversation, or assign it to an inbox and agent. Assigning to an agent alone keeps its inbox.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's id, from 'List conversations', a trigger or an earlier step.
- Status (`status`, text): Close or reopen it. Leave empty to keep its status. One of: `OPEN`, `CLOSED`.
- Inbox (`inbox_id`, text): Move it to this inbox. Leave empty to keep its inbox.
- Agent (`agent_id`, text): Assign it to this agent, who must belong to the inbox. Leave empty to keep its agent.
- Close even if unanswered (`close_even_if_unanswered`, true/false): When closing, close it even if the customer is still waiting for a reply. Default: `false`.

**Outputs**

- `conversation` (object): A Gladly conversation

**Example output**

```json
{
  "conversation": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "closed_at": "",
    "created_at": "2026-03-02T00:10:00.000Z",
    "custom_attributes": [
      {
        "id": "cEBkE90eQHObfcsnrm60Tg",
        "value": "UPS"
      }
    ],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "id": "HXRqKC5GSV-jAlq0-sxYTA",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "CLOSED",
    "topic_ids": [
      "_DZTz4I0Qsq9YXxeXwufMg"
    ]
  }
}
```

### Update conversation topics

Add topics to a conversation, remove topics from it, or both.

**Inputs**

- Conversation ID (`conversation_id`, text, required): The conversation's id, from 'List conversations', a trigger or an earlier step.
- Topics to add (`add_topic_ids`, list): Topics to add to it.
- Topics to remove (`remove_topic_ids`, list): Topics to take off it.

**Outputs**

- `added_topic_ids` (list): The topics added
- `conversation` (object): A Gladly conversation
- `removed_topic_ids` (list): The topics removed

**Example output**

```json
{
  "added_topic_ids": [
    "_DZTz4I0Qsq9YXxeXwufMg"
  ],
  "conversation": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "closed_at": "",
    "created_at": "2026-03-02T00:10:00.000Z",
    "custom_attributes": [
      {
        "id": "cEBkE90eQHObfcsnrm60Tg",
        "value": "UPS"
      }
    ],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "id": "HXRqKC5GSV-jAlq0-sxYTA",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "OPEN",
    "topic_ids": [
      "_DZTz4I0Qsq9YXxeXwufMg"
    ]
  },
  "removed_topic_ids": []
}
```

### Update customer

Change a customer's name, primary email or phone, text message setting, address or custom attributes. Empty fields are kept.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Find customers', a trigger or an earlier step.
- Name (`name`, text): The customer's full name. Leave empty to keep it.
- Email (`email`, text): Becomes their primary email address; their other addresses are kept. Leave empty to keep it.
- Phone (`phone`, text): Their phone number with its country code, such as +14155550100. Becomes their primary number; others are kept.
- Phone type (`phone_type`, text): What kind of number it is. Leave empty to keep it. One of: `MOBILE`, `HOME`, `OFFICE`.
- Text messages (`sms_preference`, text): Whether Gladly may text this number. Texts go only to a number set to On. Leave empty to keep it. One of: `ON` (On: texts may be sent), `OFF` (Off: no texts for now), `FORBIDDEN` (Forbidden: never text this number).
- Street address (`address`, text): The customer's street address. Leave empty to keep it.
- External customer ID (`external_customer_id`, text): The customer's id in your own system, for a lookup adapter installed before May 2021. Leave empty to keep it.
- Custom attributes (`custom_attributes`, object): Your organization's own customer fields, such as {"membershipTier": "gold"}. Only the names given change.

**Outputs**

- `customer` (object): A Gladly customer profile

**Example output**

```json
{
  "customer": {
    "address": "563 Rigoberto Station Apt. 197",
    "created_at": "2026-02-21T07:15:18.072Z",
    "custom_attributes": {
      "membershipTier": "gold"
    },
    "email": "martha.williams@example.com",
    "emails": [
      {
        "address": "martha.williams@example.com",
        "primary": true
      }
    ],
    "external_customer_id": "",
    "external_customer_ids": {},
    "id": "OOrlNMXeS72gs_WEX2TtMg",
    "image_url": "",
    "name": "Martha Williams",
    "phone": "+17244895501",
    "phones": [
      {
        "extension": "",
        "number": "+17244895501",
        "primary": true,
        "sms_preference": "ON",
        "type": "MOBILE"
      }
    ],
    "updated_at": "2026-02-21T19:50:23.486Z"
  }
}
```

### Update task

Close or reopen a task, or change what it says, when it is due or who has it. Empty fields are kept.

**Inputs**

- Task ID (`task_id`, text, required): The task's id, from 'Create task', 'List tasks' or a trigger.
- Status (`status`, text): Close or reopen it. Leave empty to keep its status. One of: `OPEN`, `CLOSED`.
- Task (`description`, text): What needs doing. Leave empty to keep it.
- Due (`due_at`, date and time): When it is due. Leave empty to keep it.
- Inbox (`inbox_id`, text): Move it to this inbox. Leave empty to keep its inbox.
- Agent (`agent_id`, text): Give it to this agent, who must belong to the inbox. Leave empty to keep its agent.

**Outputs**

- `task` (object): A Gladly task: follow-up work for a customer

**Example output**

```json
{
  "task": {
    "agent_id": "sHuXx-U3QqOmhvFusJGeBw",
    "body": "Call the customer back about their booking",
    "body_text": "Call the customer back about their booking",
    "created_at": "2026-03-02T04:30:12.070Z",
    "created_by_id": "",
    "created_by_type": "API",
    "custom_attributes": [],
    "customer_id": "OOrlNMXeS72gs_WEX2TtMg",
    "due_at": "2026-03-15T06:13:00.000Z",
    "id": "dzweSumI4bFxjlT8LApOVV",
    "inbox_id": "E1nArq1uQAees_DogHB0MA",
    "status": "CLOSED",
    "topic_ids": []
  }
}
```
