Gladly

App · 25 actions

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.

Actions

ActionWhat it does
Add customer activityPut an activity from another system (an order issue, a survey answer, an email it sent) on a customer's timeline for agents to see.
Add noteAdd an internal note to a conversation.
Add task commentComment on an open task, as the connected Gladly user or as the agent you choose.
Create customerAdd a customer profile with an email address, a phone number or both.
Create taskAdd 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.
Delete customerDelete a customer profile and its timeline.
Find answersFind answers in Gladly's knowledge base by words in their name or description, most recently changed first.
Find customersFind customer profiles by email address, phone number or external customer id.
Get answerGet the words of a knowledge-base answer in one language and form: reference, public, email or messaging.
Get conversationGet a conversation's status, inbox, agent, topics and when it started and closed.
Get customerGet a customer's profile: name, email addresses, phone numbers and custom attributes.
Get taskGet a task: what it says, its status, when it is due and who has it.
List agentsList the organization's agents with their ids and email addresses.
List conversation itemsRead a conversation's timeline, oldest first: emails, texts, chats, calls, notes and status changes, each with its text.
List conversationsList a customer's conversations, newest first, with their status, inbox, agent and topics.
List inboxesList the organization's inboxes with their ids.
List tasksList a customer's tasks, newest first.
List topicsList the topics conversations and tasks can be labelled with, with their full paths.
Reply to messageReply to a customer's message on the channel it came in on: email, chat, text, WhatsApp, Facebook or Instagram.
Send emailEmail a customer from one of your Gladly support addresses.
Send text messageText a customer by their mobile number, from one of your Gladly numbers.
Update conversationClose or reopen a conversation, or assign it to an inbox and agent.
Update conversation topicsAdd topics to a conversation, remove topics from it, or both.
Update customerChange a customer's name, primary email or phone, text message setting, address or custom attributes.
Update taskClose or reopen a task, or change what it says, when it is due or who has it.

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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.
TitletitletextRequired
The first, highlighted line, such as Order 1001 delayed.
Detailsbodytext
The rest of the card. Plain text or simple HTML.
Iconactivity_typetext
Which icon the card shows. Defaults to Issue.One of: ISSUE, EMAIL, SMS (Text message), SURVEY. Default: ISSUE.
Sourcesource_nametext
The system it came from, such as Shopify.
Linklink_urltext
A web address to show at the bottom of the card.
Link textlink_texttext
The link's label, such as View order.
Happened atoccurred_atdate and time
When it happened, which places it on the timeline (within the last year). Leave empty for now.
Show expandedexpand_by_defaulttrue/false
Show the card opened up on the timeline.Default: false.

Outputs

activityobject
The activity, as it is on the timeline
activity_idtext
The activity's id
Example output
{
  "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 IDconversation_idtextRequired
The conversation's id, from 'List conversations', a trigger or an earlier step.
NotenotetextRequired
What the note says. Plain text or simple HTML.

Outputs

conversation_idtext
The conversation the note is on
notetext
What the note says
note_idtext
The new note's id, or empty if Gladly did not say
Example output
{
  "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 IDtask_idtextRequired
The task's id, from 'Create task', 'List tasks' or a trigger.
CommentcommenttextRequired
What the comment says.
Agentagent_idtext
Who the comment is from. Leave empty for the connected user.

Outputs

commentobject
A comment on a task
comment_idtext
The new comment's id
Example output
{
  "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

Namenametext
The customer's full name.
Emailemailtext
Their email address. Gladly needs an email or a phone number for a new customer, and no two customers may share one.
Phonephonetext
Their phone number with its country code, such as +14155550100.
Phone typephone_typetext
What kind of number it is.One of: MOBILE, HOME, OFFICE.
Text messagessms_preferencetext
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 addressaddresstext
The customer's street address.
External customer IDexternal_customer_idtext
The customer's id in your own system, for a lookup adapter installed before May 2021.
Custom attributescustom_attributesobject
Your organization's own customer fields, such as {"membershipTier": "gold"}. Only the names given change.
Customer IDcustomer_idtext
An id of your own for the customer (letters, digits, - and _). Leave empty and one is made.

Outputs

customerobject
A Gladly customer profile
customer_idtext
The new customer's id
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.
TaskdescriptiontextRequired
What needs doing, such as Call back about the refund.
Duedue_atdate and timeRequired
When it is due. It must be in the future.
Inboxinbox_idtextRequired
The inbox the task goes to.
Agentagent_idtext
The agent to give it to, who must belong to the inbox.
Topicstopic_idslist
Topics to label it with. A topic that only groups others can't be used.

Outputs

taskobject
A Gladly task: follow-up work for a customer
task_idtext
The new task's id
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.

Outputs

customer_idtext
The customer deleted
deletedtrue/false
Always true once deleted
Example output
{
  "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 findsearchtext
Every word must be in the answer's name or description. Leave empty for every answer.
Languagelanguagetext
Only answers written in this language, such as en-us.
Most to returnlimitnumber
How many answers to return, 1 to 100.From 1 to 100. Default: 25.

Outputs

answerslist
The answers found
countnumber
How many there are
total_matchesnumber
How many answers matched, before the limit
Example output
{
  "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 byfind_bytext
What to search on. Defaults to email address.One of: email (Email address), phone (Phone number), external_id (External customer ID). Default: email.
Search forvaluetextRequired
The email address, phone number (with its country code, such as +14155550100) or external id to find.

Outputs

countnumber
How many there are
customer_idtext
The first customer's id, or empty if none
customerslist
The customers found
foundtrue/false
Whether any customer was found
Example output
{
  "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

Answeranswer_idtextRequired
The answer. Pick one, or give its id from 'Find answers'.
Languagelanguagetext
Such as en-us. Leave empty for English, or else the first language it is written in.
Formcontent_typetext
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

answerobject
An answer in Gladly's knowledge base
body_htmltext
The answer's words as HTML
body_texttext
The answer's words as plain text
content_typetext
The form read: reference, public, email or messaging
internaltrue/false
Whether it is for agents only, for a reference answer
languagetext
The language read, such as en-us
subjecttext
The subject line, for an email answer
titletext
The title, for a public answer
Example output
{
  "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 IDconversation_idtextRequired
The conversation's id, from 'List conversations', a trigger or an earlier step.

Outputs

conversationobject
A Gladly conversation
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.

Outputs

customerobject
A Gladly customer profile
Example output
{
  "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 IDtask_idtextRequired
The task's id, from 'Create task', 'List tasks' or a trigger.

Outputs

taskobject
A Gladly task: follow-up work for a customer
Example output
{
  "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 containssearchtext
Only agents whose name or email has this text.

Outputs

agentslist
The agents
countnumber
How many there are
Example output
{
  "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 IDconversation_idtextRequired
The conversation's id, from 'List conversations', a trigger or an earlier step.

Outputs

countnumber
How many there are
itemslist
The timeline, oldest first
latest_item_idtext
The newest item's id, or empty
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.
Statusstatustext
Only conversations with this status. Defaults to any.One of: ANY (Any status), OPEN, WAITING, CLOSED. Default: ANY.

Outputs

conversationslist
The conversations, newest first
countnumber
How many there are
latest_conversation_idtext
The newest conversation's id, or empty
Example output
{
  "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 inboxesinclude_disabledtrue/false
Also list inboxes that are turned off.Default: false.

Outputs

countnumber
How many there are
inboxeslist
The inboxes
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.
Statusstatustext
Only tasks with this status. Defaults to any.One of: ANY (Any status), OPEN, CLOSED. Default: ANY.

Outputs

countnumber
How many there are
taskslist
The tasks, newest first
Example output
{
  "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 containssearchtext
Only topics whose name (or a parent's) has this text.
Include retired topicsinclude_disabledtrue/false
Also list topics that can no longer be applied.Default: false.

Outputs

countnumber
How many there are
topicslist
The topics
Example output
{
  "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 IDmessage_idtextRequired
The id of the customer's message, from 'Message received' or 'List conversation items'.
ReplyreplytextRequired
What to say. Line breaks are kept.

Outputs

channeltext
The channel the reply went on, such as EMAIL or SMS
conversation_idtext
The conversation it is part of
customer_idtext
The customer replied to
message_idtext
The message replied to
repliedtrue/false
Always true once Gladly took the reply
reply_idtext
The reply's id, or empty if Gladly did not say
Example output
{
  "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

TototextRequired
The customer's email address.
Customer nameto_nametext
Their name, used if Gladly adds them as a new customer.
SubjectsubjecttextRequired
The subject line, under 1,000 characters.
MessagemessagetextRequired
What to say. Line breaks are kept.
Fromsendertext
The Gladly support address to send from. Leave empty for your first one.

Outputs

customer_idtext
The customer emailed
fromtext
The address it was sent from
message_idtext
The email's id on the customer's timeline
senttrue/false
Always true once Gladly took the email
totext
The address emailed
Example output
{
  "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

TototextRequired
The customer's mobile number with its country code, such as +14155550100.
MessagemessagetextRequired
What to say. Long texts are sent and paid for in parts.
Fromsendertext
The Gladly number to send from. Leave empty for your first text messaging number.

Outputs

conversation_idtext
The conversation it joined, or empty if not known yet
customer_idtext
The customer texted
fromtext
The number it was sent from
message_idtext
The text's id on the customer's timeline
senttrue/false
Always true once Gladly took the text
totext
The number texted
Example output
{
  "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 IDconversation_idtextRequired
The conversation's id, from 'List conversations', a trigger or an earlier step.
Statusstatustext
Close or reopen it. Leave empty to keep its status.One of: OPEN, CLOSED.
Inboxinbox_idtext
Move it to this inbox. Leave empty to keep its inbox.
Agentagent_idtext
Assign it to this agent, who must belong to the inbox. Leave empty to keep its agent.
Close even if unansweredclose_even_if_unansweredtrue/false
When closing, close it even if the customer is still waiting for a reply.Default: false.

Outputs

conversationobject
A Gladly conversation
Example output
{
  "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 IDconversation_idtextRequired
The conversation's id, from 'List conversations', a trigger or an earlier step.
Topics to addadd_topic_idslist
Topics to add to it.
Topics to removeremove_topic_idslist
Topics to take off it.

Outputs

added_topic_idslist
The topics added
conversationobject
A Gladly conversation
removed_topic_idslist
The topics removed
Example output
{
  "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 IDcustomer_idtextRequired
The customer's id, from 'Find customers', a trigger or an earlier step.
Namenametext
The customer's full name. Leave empty to keep it.
Emailemailtext
Becomes their primary email address; their other addresses are kept. Leave empty to keep it.
Phonephonetext
Their phone number with its country code, such as +14155550100. Becomes their primary number; others are kept.
Phone typephone_typetext
What kind of number it is. Leave empty to keep it.One of: MOBILE, HOME, OFFICE.
Text messagessms_preferencetext
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 addressaddresstext
The customer's street address. Leave empty to keep it.
External customer IDexternal_customer_idtext
The customer's id in your own system, for a lookup adapter installed before May 2021. Leave empty to keep it.
Custom attributescustom_attributesobject
Your organization's own customer fields, such as {"membershipTier": "gold"}. Only the names given change.

Outputs

customerobject
A Gladly customer profile
Example output
{
  "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 IDtask_idtextRequired
The task's id, from 'Create task', 'List tasks' or a trigger.
Statusstatustext
Close or reopen it. Leave empty to keep its status.One of: OPEN, CLOSED.
Taskdescriptiontext
What needs doing. Leave empty to keep it.
Duedue_atdate and time
When it is due. Leave empty to keep it.
Inboxinbox_idtext
Move it to this inbox. Leave empty to keep its inbox.
Agentagent_idtext
Give it to this agent, who must belong to the inbox. Leave empty to keep its agent.

Outputs

taskobject
A Gladly task: follow-up work for a customer
Example output
{
  "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": []
  }
}

On this page