Kustomer
App · 25 actions
Work with your Kustomer customer service platform: create and update customers, companies and custom objects, manage conversations, log messages, draft replies and add notes, and start workflows when conversations, messages and customers change.
Actions
| Action | What it does |
|---|---|
| Add note | Add an internal note to a conversation. |
| Add tags to conversation | Tag a conversation. |
| Create company | Add a company to Kustomer, to group the customers who work there. |
| Create conversation | Start a conversation on a customer's timeline, optionally assigned to people or teams. |
| Create custom object | Add a custom object, such as an order, optionally on a customer's or a company's timeline. |
| Create customer | Add a customer to Kustomer. |
| Create draft reply | Write an email or SMS draft to a customer for an agent to review and send in Kustomer, or schedule Kustomer to send it at a time you choose. |
| Delete conversation | Delete a conversation, with its messages and notes, for good. |
| Delete custom object | Delete a custom object for good. |
| Delete customer | Delete a customer from Kustomer for good. |
| Find company | Look up one company by its Kustomer ID or external ID. |
| Find conversation | Look up one conversation by its Kustomer ID or external ID. |
| Find custom object | Look up one custom object by its Kustomer ID or external ID. |
| Find customer | Look up one customer by email address, phone number, external ID or Kustomer ID. |
| List conversation messages | List the messages in a conversation, with who sent each and when. |
| List conversation notes | List the internal notes on a conversation. |
| List custom object types | List the kinds of custom object your Kustomer organization keeps, such as orders or bookings, with the names the other steps take. |
| Log message | Record a message that happened outside Kustomer (a form, a call, another inbox) on a conversation's timeline. |
| Remove tags from conversation | Take tags off a conversation, by name. |
| Search conversations | Find conversations by status, assignee, customer, or when they were created or last changed. |
| Search customers | Find customers by part of their name, email, phone, or when they were created or last changed. |
| Update company | Change a company's name, external ID, domain or custom attributes. |
| Update conversation | Change a conversation's status (open, snoozed until a time, or done), priority, assignees, name or custom attributes. |
| Update custom object | Change a custom object's title, description, external ID or custom attributes. |
| Update customer | Change a customer's name, email, phone, external ID, company or custom attributes. |
Add note
Add an internal note to a conversation. Only your team sees notes.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Note
bodytextRequired - What the note says.
Outputs
noteobject- The note
Example output
{
"note": {
"body": "Checked with the warehouse: it ships tomorrow.",
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"created_at": "2026-10-21T09:20:46.480Z",
"created_by": "5f0f56d3fee2930019723507",
"customer_id": "5f8efdd5d3de932f344ca367",
"id": "5828a4fea68d651100f0a2f8",
"updated_at": "2026-10-21T09:20:46.480Z"
}
}Add tags to conversation
Tag a conversation. A tag name Kustomer doesn't have yet is created.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Tags
tagslistRequired - The tags, by name. Pick them, or type names.
Outputs
conversationobject- The conversation
Example output
{
"conversation": {
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [
"5849765dc41e372700cc84a3"
],
"updated_at": "2026-10-21T09:15:42.004Z"
}
}Create company
Add a company to Kustomer, to group the customers who work there.
Inputs
- Name
nametextRequired - The company's name.
- External ID
external_idtext - Your own id for it, such as the id in another system.
- Domain
domaintext - Its web domain, such as example.com. A full address works too.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
companyobject- The company
Example output
{
"company": {
"created_at": "2026-09-02T10:00:00.000Z",
"custom": {
"planStr": "enterprise"
},
"domains": [
"acme.example"
],
"external_id": "acct-2201",
"id": "6195640664b2fbb9eddc1e9b",
"name": "Acme Outfitters",
"tags": [],
"updated_at": "2026-10-01T16:30:00.000Z"
}
}Create conversation
Start a conversation on a customer's timeline, optionally assigned to people or teams. Add messages to it with 'Log message' or 'Create draft reply'.
Inputs
- Customer ID
customer_idtextRequired - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
- Name
nametext - What the conversation is about, as its subject.
- Status
statustext - Open, or Done for one that needs nothing more.One of:
open,done. Default:open. - Priority
prioritynumber - 1 is the lowest and 5 is urgent. Kustomer starts conversations at 3.From 1 to 5.
- Assigned users
assigned_userslist - The people to assign it to. Pick them, or give user ids.
- Assigned teams
assigned_teamslist - The teams to assign it to. Pick them, or give team ids.
- External ID
external_idtext - Your own id for it, such as the id in another system.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
conversationobject- The conversation
Example output
{
"conversation": {
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [
"5849765dc41e372700cc84a3"
],
"updated_at": "2026-10-21T09:15:42.004Z"
}
}Create custom object
Add a custom object, such as an order, optionally on a customer's or a company's timeline.
Inputs
- Custom object type
object_typetextRequired - The kind of custom object, such as Order. Pick one, or give its name from 'List custom object types'.
- Title
titletextRequired - What Kustomer shows for it, such as Order #1059.
- Description
descriptiontext - A longer description.
- External ID
external_idtext - Your own id for it, such as the id in another system.
- Customer ID
customer_idtext - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
- Company ID
company_idtext - The company's Kustomer id, from a trigger or an earlier step. A Kustomer link to the company works too.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
custom_objectobject- The custom object
Example output
{
"custom_object": {
"company_id": "",
"created_at": "2026-10-20T05:39:36.976Z",
"custom": {
"orderStatusStr": "fulfilled",
"totalPriceNum": 64.67
},
"customer_id": "5f8efdd5d3de932f344ca367",
"description": "3 items ordered for $64.67",
"external_id": "order-1059",
"id": "5f8efdd5d3de932f344ca369",
"object_type": "order",
"tags": [],
"title": "Order #1059",
"updated_at": "2026-10-20T05:39:36.976Z"
}
}Create customer
Add a customer to Kustomer. Give at least a name, an email, a phone number or an external ID.
Inputs
- Name
nametext - The customer's full name.
- Email
emailtext - Their email address.
- Phone
phonetext - Their phone number with country code, such as +15551234567.
- External ID
external_idtext - Your own id for them, such as their id in your store or CRM.
- Company ID
company_idtext - The company's Kustomer id, from a trigger or an earlier step. A Kustomer link to the company works too.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
customerobject- The customer
Example output
{
"customer": {
"company_id": "6195640664b2fbb9eddc1e9b",
"created_at": "2026-10-20T14:02:11.120Z",
"custom": {
"loyaltyTierStr": "gold"
},
"display_name": "Jane Doe",
"email": "jane.doe@example.com",
"emails": [
"jane.doe@example.com"
],
"external_id": "crm-10442",
"id": "5f8efdd5d3de932f344ca367",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"locale": "en_US",
"name": "Jane Doe",
"phone": "+12065551234",
"phones": [
"+12065551234"
],
"tags": [
"5822a4a5aa5f92110005d696"
],
"time_zone": "America/New_York",
"updated_at": "2026-10-21T09:15:42.004Z"
}
}Create draft reply
Write an email or SMS draft to a customer for an agent to review and send in Kustomer, or schedule Kustomer to send it at a time you choose.
Inputs
- Customer ID
customer_idtextRequired - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
- Channel
channeltext - Email or SMS.One of:
email,sms. Default:email. - To
totextRequired - The customer's email address for an email, or their phone number with country code for an SMS.
- Message
bodytextRequired - What the message says.
- Subject
subjecttext - The email's subject.Only when Channel is Email.
- Conversation ID
conversation_idtext - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- From
from_addresstext - The email address or phone number of yours in Kustomer to send from. Leave blank to let the agent choose.
- Send at
send_atdate and time - Have Kustomer send it at this time. Leave blank to keep it as a draft for an agent to send.
Outputs
draftobject- The draft
Example output
{
"draft": {
"channel": "email",
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"created_at": "2026-10-21T09:25:07.575Z",
"customer_id": "5f8efdd5d3de932f344ca367",
"id": "5823e4d3bff98a100085320e",
"send_at": "",
"status": "draft"
}
}Delete conversation
Delete a conversation, with its messages and notes, for good.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
Outputs
conversation_idtext- The id of the deleted conversation
deletedtrue/false- True once Kustomer has deleted the conversation
Example output
{
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"deleted": true
}Delete custom object
Delete a custom object for good.
Inputs
- Custom object type
object_typetextRequired - The kind of custom object, such as Order. Pick one, or give its name from 'List custom object types'.
- Custom object ID
object_idtextRequired - The custom object's Kustomer id, from 'Create custom object', 'Find custom object' or a trigger.
Outputs
deletedtrue/false- True once Kustomer has deleted the custom object
object_idtext- The id of the deleted custom object
Example output
{
"deleted": true,
"object_id": "5f8efdd5d3de932f344ca369"
}Delete customer
Delete a customer from Kustomer for good.
Inputs
- Customer ID
customer_idtextRequired - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
Outputs
customer_idtext- The id of the deleted customer
deletedtrue/false- True once Kustomer has deleted the customer
Example output
{
"customer_id": "5f8efdd5d3de932f344ca367",
"deleted": true
}Find company
Look up one company by its Kustomer ID or external ID. Says whether one was found, without failing when not.
Inputs
- Find by
find_bytext - What to look it up by.One of:
id(Kustomer ID),external_id(External ID). Default:id. - Look up
valuetextRequired - The company to find, as chosen in Find by.
Outputs
companyobject- The company, or nothing if not found
foundtrue/false- Whether Kustomer has such a company
Example output
{
"company": {
"created_at": "2026-09-02T10:00:00.000Z",
"custom": {
"planStr": "enterprise"
},
"domains": [
"acme.example"
],
"external_id": "acct-2201",
"id": "6195640664b2fbb9eddc1e9b",
"name": "Acme Outfitters",
"tags": [],
"updated_at": "2026-10-01T16:30:00.000Z"
},
"found": true
}Find conversation
Look up one conversation by its Kustomer ID or external ID. Says whether one was found, without failing when not.
Inputs
- Find by
find_bytext - What to look it up by.One of:
id(Kustomer ID),external_id(External ID). Default:id. - Look up
valuetextRequired - The conversation to find, as chosen in Find by.
Outputs
conversationobject- The conversation, or nothing if not found
foundtrue/false- Whether Kustomer has such a conversation
Example output
{
"conversation": {
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [
"5849765dc41e372700cc84a3"
],
"updated_at": "2026-10-21T09:15:42.004Z"
},
"found": true
}Find custom object
Look up one custom object by its Kustomer ID or external ID. Says whether one was found, without failing when not.
Inputs
- Custom object type
object_typetextRequired - The kind of custom object, such as Order. Pick one, or give its name from 'List custom object types'.
- Find by
find_bytext - What to look it up by.One of:
id(Kustomer ID),external_id(External ID). Default:id. - Look up
valuetextRequired - The custom object to find, as chosen in Find by.
Outputs
custom_objectobject- The custom object, or nothing if not found
foundtrue/false- Whether Kustomer has such a custom object
Example output
{
"custom_object": {
"company_id": "",
"created_at": "2026-10-20T05:39:36.976Z",
"custom": {
"orderStatusStr": "fulfilled",
"totalPriceNum": 64.67
},
"customer_id": "5f8efdd5d3de932f344ca367",
"description": "3 items ordered for $64.67",
"external_id": "order-1059",
"id": "5f8efdd5d3de932f344ca369",
"object_type": "order",
"tags": [],
"title": "Order #1059",
"updated_at": "2026-10-20T05:39:36.976Z"
},
"found": true
}Find customer
Look up one customer by email address, phone number, external ID or Kustomer ID. Says whether one was found, without failing when not.
Inputs
- Find by
find_bytext - What to look it up by.One of:
email(Email address),phone(Phone number),external_id(External ID),id(Kustomer ID). Default:email. - Look up
valuetextRequired - The customer to find, as chosen in Find by.
Outputs
customerobject- The customer, or nothing if not found
foundtrue/false- Whether Kustomer has such a customer
Example output
{
"customer": {
"company_id": "6195640664b2fbb9eddc1e9b",
"created_at": "2026-10-20T14:02:11.120Z",
"custom": {
"loyaltyTierStr": "gold"
},
"display_name": "Jane Doe",
"email": "jane.doe@example.com",
"emails": [
"jane.doe@example.com"
],
"external_id": "crm-10442",
"id": "5f8efdd5d3de932f344ca367",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"locale": "en_US",
"name": "Jane Doe",
"phone": "+12065551234",
"phones": [
"+12065551234"
],
"tags": [
"5822a4a5aa5f92110005d696"
],
"time_zone": "America/New_York",
"updated_at": "2026-10-21T09:15:42.004Z"
},
"found": true
}List conversation messages
List the messages in a conversation, with who sent each and when.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Order
ordertext - Newest or oldest first.One of:
desc(Newest first),asc(Oldest first). Default:desc. - Page
pagenumber - Which page of results to return, from 1. Kustomer serves up to 100.From 1 to 100. Default:
1. - Page size
page_sizenumber - How many to return, 1 to 100.From 1 to 100. Default:
25.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is a page after this one
messageslist- The messages on this page
pagenumber- The page number
Example output
{
"count": 1,
"has_more": false,
"messages": [
{
"app": "postmark",
"channel": "email",
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"created_at": "2026-10-21T09:10:02.851Z",
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "608738673041c80019692cdf",
"preview": "Hi, my order hasn't arrived yet. Can you check on it?",
"sent_at": "2026-10-21T09:10:01.000Z",
"status": "received",
"subject": "Where is my order?"
}
],
"page": 1
}List conversation notes
List the internal notes on a conversation.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Order
ordertext - Newest or oldest first.One of:
desc(Newest first),asc(Oldest first). Default:desc. - Page
pagenumber - Which page of results to return, from 1. Kustomer serves up to 100.From 1 to 100. Default:
1. - Page size
page_sizenumber - How many to return, 1 to 100.From 1 to 100. Default:
25.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there is a page after this one
noteslist- The notes on this page
pagenumber- The page number
Example output
{
"count": 1,
"has_more": false,
"notes": [
{
"body": "Checked with the warehouse: it ships tomorrow.",
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"created_at": "2026-10-21T09:20:46.480Z",
"created_by": "5f0f56d3fee2930019723507",
"customer_id": "5f8efdd5d3de932f344ca367",
"id": "5828a4fea68d651100f0a2f8",
"updated_at": "2026-10-21T09:20:46.480Z"
}
],
"page": 1
}List custom object types
List the kinds of custom object your Kustomer organization keeps, such as orders or bookings, with the names the other steps take.
Inputs
None.
Outputs
countnumber- How many there are
typeslist- The custom object types
Example output
{
"count": 1,
"types": [
{
"created_at": "2026-01-30T03:09:03.258Z",
"display_name": "Order",
"id": "5815c0f5a4d1c111006b2f2a",
"name": "order",
"status": "enabled",
"updated_at": "2026-02-12T05:15:09.250Z"
}
]
}Log message
Record a message that happened outside Kustomer (a form, a call, another inbox) on a conversation's timeline. Nothing is sent to the customer.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Text
texttextRequired - What the message said.
- Channel
channeltext - Where the message was sent or received.One of:
email,sms,chat,voice,whatsapp,facebook,instagram,twitter-dm(X (Twitter) direct message),twitter-tweet(X (Twitter) post). Default:email. - Direction
directiontext - Whether the customer sent it or your team did.One of:
in(From the customer),out(To the customer). Default:in. - Subject
subjecttext - Its subject, for an email.
- Sent at
sent_atdate and time - When it was sent. Leave blank for now.
Outputs
messageobject- The message
Example output
{
"message": {
"app": "lodol",
"channel": "email",
"conversation_id": "5faaf4a6ea0cb48cd0801bbf",
"created_at": "2026-10-21T09:10:02.851Z",
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "608738673041c80019692cdf",
"preview": "Hi, my order hasn't arrived yet. Can you check on it?",
"sent_at": "2026-10-21T09:10:01.000Z",
"status": "received",
"subject": "Where is my order?"
}
}Remove tags from conversation
Take tags off a conversation, by name.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Tags
tagslistRequired - The tags, by name. Pick them, or type names.
Outputs
conversationobject- The conversation
Example output
{
"conversation": {
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [],
"updated_at": "2026-10-21T09:15:42.004Z"
}
}Search conversations
Find conversations by status, assignee, customer, or when they were created or last changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Status
statustext - Only conversations with this status.One of:
open,snoozed,done. - Assigned team
assigned_teamtext - Only conversations assigned to this team.
- Assigned user
assigned_usertext - Only conversations assigned to this person.
- Customer ID
customer_idtext - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
- Created after
created_afterdate and time - Only those created at or after this time.
- Updated after
updated_afterdate and time - Only those changed at or after this time.
- Sort by
sort_bytext - The order to return them in.One of:
newest(Newest first),oldest(Oldest first),recently_updated(Recently updated first),priority(Highest priority first). Default:newest. - Page
pagenumber - Which page of results to return, from 1. Kustomer serves up to 100.From 1 to 100. Default:
1. - Page size
page_sizenumber - How many to return, 1 to 100.From 1 to 100. Default:
25.
Outputs
conversationslist- The conversations on this page
countnumber- How many are on this page
has_moretrue/false- Whether there is a page after this one
pagenumber- The page number
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"conversations": [
{
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [
"5849765dc41e372700cc84a3"
],
"updated_at": "2026-10-21T09:15:42.004Z"
}
],
"count": 1,
"has_more": false,
"page": 1,
"total": 1,
"total_pages": 1
}Search customers
Find customers by part of their name, email, phone, or when they were created or last changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
name_containstext - Part of the customer's name.
- Email
emailtext - Their exact email address.
- Phone
phonetext - Their phone number with country code, such as +15551234567.
- Created after
created_afterdate and time - Only those created at or after this time.
- Updated after
updated_afterdate and time - Only those changed at or after this time.
- Sort by
sort_bytext - The order to return them in.One of:
newest(Newest first),oldest(Oldest first),recently_updated(Recently updated first),name(Name, A to Z). Default:newest. - Page
pagenumber - Which page of results to return, from 1. Kustomer serves up to 100.From 1 to 100. Default:
1. - Page size
page_sizenumber - How many to return, 1 to 100.From 1 to 100. Default:
25.
Outputs
countnumber- How many are on this page
customerslist- The customers on this page
has_moretrue/false- Whether there is a page after this one
pagenumber- The page number
totalnumber- How many match in all
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"customers": [
{
"company_id": "6195640664b2fbb9eddc1e9b",
"created_at": "2026-10-20T14:02:11.120Z",
"custom": {
"loyaltyTierStr": "gold"
},
"display_name": "Jane Doe",
"email": "jane.doe@example.com",
"emails": [
"jane.doe@example.com"
],
"external_id": "crm-10442",
"id": "5f8efdd5d3de932f344ca367",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"locale": "en_US",
"name": "Jane Doe",
"phone": "+12065551234",
"phones": [
"+12065551234"
],
"tags": [
"5822a4a5aa5f92110005d696"
],
"time_zone": "America/New_York",
"updated_at": "2026-10-21T09:15:42.004Z"
}
],
"has_more": false,
"page": 1,
"total": 1,
"total_pages": 1
}Update company
Change a company's name, external ID, domain or custom attributes. Fields left blank keep their value.
Inputs
- Company ID
company_idtextRequired - The company's Kustomer id, from a trigger or an earlier step. A Kustomer link to the company works too.
- Name
nametext - The company's name.
- External ID
external_idtext - Your own id for it, such as the id in another system.
- Domain
domaintext - Its web domain, such as example.com. A full address works too.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
companyobject- The company
Example output
{
"company": {
"created_at": "2026-09-02T10:00:00.000Z",
"custom": {
"planStr": "enterprise"
},
"domains": [
"acme.example"
],
"external_id": "acct-2201",
"id": "6195640664b2fbb9eddc1e9b",
"name": "Acme Outfitters",
"tags": [],
"updated_at": "2026-10-01T16:30:00.000Z"
}
}Update conversation
Change a conversation's status (open, snoozed until a time, or done), priority, assignees, name or custom attributes. Fields left blank keep their value; assignees given replace the ones there.
Inputs
- Conversation ID
conversation_idtextRequired - The conversation's Kustomer id, from a trigger or an earlier step. A Kustomer link to the conversation works too.
- Status
statustext - Open, Snoozed until a time, or Done.One of:
open,snoozed,done. - Snooze until
snooze_untildate and time - When the snoozed conversation opens again.Only when Status is Snoozed.
- Priority
prioritynumber - 1 is the lowest and 5 is urgent. Kustomer starts conversations at 3.From 1 to 5.
- Assigned users
assigned_userslist - The people to assign it to. Pick them, or give user ids.
- Assigned teams
assigned_teamslist - The teams to assign it to. Pick them, or give team ids.
- Name
nametext - A new name (subject) for it.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
conversationobject- The conversation
Example output
{
"conversation": {
"assigned_teams": [
"608733a7178c7116b82c5e9a"
],
"assigned_users": [
"5f0f56d3fee2930019723507"
],
"channels": [
"email"
],
"created_at": "2026-10-21T09:10:02.552Z",
"custom": {},
"customer_id": "5f8efdd5d3de932f344ca367",
"direction": "in",
"external_id": "",
"id": "5faaf4a6ea0cb48cd0801bbf",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"message_count": 2,
"name": "Where is my order?",
"note_count": 1,
"priority": 3,
"snoozed_until": "",
"status": "open",
"tags": [
"5849765dc41e372700cc84a3"
],
"updated_at": "2026-10-21T09:15:42.004Z"
}
}Update custom object
Change a custom object's title, description, external ID or custom attributes. Fields left blank keep their value.
Inputs
- Custom object type
object_typetextRequired - The kind of custom object, such as Order. Pick one, or give its name from 'List custom object types'.
- Custom object ID
object_idtextRequired - The custom object's Kustomer id, from 'Create custom object', 'Find custom object' or a trigger.
- Title
titletext - What Kustomer shows for it, such as Order #1059.
- Description
descriptiontext - A longer description.
- External ID
external_idtext - Your own id for it, such as the id in another system.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
custom_objectobject- The custom object
Example output
{
"custom_object": {
"company_id": "",
"created_at": "2026-10-20T05:39:36.976Z",
"custom": {
"orderStatusStr": "fulfilled",
"totalPriceNum": 64.67
},
"customer_id": "5f8efdd5d3de932f344ca367",
"description": "3 items ordered for $64.67",
"external_id": "order-1059",
"id": "5f8efdd5d3de932f344ca369",
"object_type": "order",
"tags": [],
"title": "Order #1059",
"updated_at": "2026-10-20T05:39:36.976Z"
}
}Update customer
Change a customer's name, email, phone, external ID, company or custom attributes. Fields left blank keep their value.
Inputs
- Customer ID
customer_idtextRequired - The customer's Kustomer id, from a trigger or an earlier step. A Kustomer link to the customer works too.
- Name
nametext - The customer's full name.
- Email
emailtext - Their email address. Replaces the ones on the customer.
- Phone
phonetext - Their phone number with country code, such as +15551234567. Replaces the ones on the customer.
- External ID
external_idtext - Your own id for them, such as their id in your store or CRM.
- Company ID
company_idtext - The company's Kustomer id, from a trigger or an earlier step. A Kustomer link to the company works too.
- Custom attributes
custom_attributesobject - Custom attributes to set, by their Kustomer names, such as loyaltyTierStr. The name's ending gives the type: Str or Txt for text, Num for a number, Bool for true or false, At for a date and time.
Outputs
customerobject- The customer
Example output
{
"customer": {
"company_id": "6195640664b2fbb9eddc1e9b",
"created_at": "2026-10-20T14:02:11.120Z",
"custom": {
"loyaltyTierStr": "gold"
},
"display_name": "Jane Doe",
"email": "jane.doe@example.com",
"emails": [
"jane.doe@example.com"
],
"external_id": "crm-10442",
"id": "5f8efdd5d3de932f344ca367",
"last_activity_at": "2026-10-21T09:15:42.004Z",
"locale": "en_US",
"name": "Jane Doe",
"phone": "+12065551234",
"phones": [
"+12065551234"
],
"tags": [
"5822a4a5aa5f92110005d696"
],
"time_zone": "America/New_York",
"updated_at": "2026-10-21T09:15:42.004Z"
}
}