Help Scout

Work your Help Scout shared inbox. Find, create and reply to conversations, add internal notes, tag, assign and close them, and look up, create and update customers.

Actions

Action	What it does
Add note	Add an internal note to a conversation.
Create conversation	Start a conversation in an inbox, with a first message from the customer, a reply from your team, or an internal note.
Create customer	Add a customer profile with a name, email, phone and other details.
Delete conversation	Permanently delete a conversation and all of its messages.
Delete customer	Permanently delete a customer together with all of their conversations and survey responses.
Get conversation	Read one conversation: subject, status, inbox, customer, assignee, tags, custom fields and a link to open it in Help Scout - optionally with every message and note in it.
Get current user	Read the Help Scout user this connection acts as - the person who created the app.
Get customer	Read a customer's profile: name, emails, phones, websites, job title, location, notes and how many conversations they have.
List conversation messages	List the messages, replies, notes and activity (threads) in a conversation, with their text, author and time.
List conversations	Find conversations, filtered by inbox, folder, status, tags, assignee, number or last-modified date, or with Help Scout's search syntax.
List customers	Find customers by email, name, or Help Scout's search syntax, or those created or changed since a date.
List inbox folders	List an inbox's folders (Unassigned, Mine, Closed and so on) with how many conversations each holds.
List inboxes	List the inboxes you can access, with their ids and addresses.
List saved replies	List an inbox's saved replies, with a preview of each.
List tags	List the account's tags and how many conversations use each.
List users	List your Help Scout teammates, optionally only those with access to one inbox or with one email address.
Reply to conversation	Reply to the customer on a conversation.
Tag conversation	Add tags to a conversation, remove some, replace them all, or clear them.
Update conversation	Change a conversation's subject, status, inbox, primary customer or assignee, or unassign it.
Update customer	Change a customer's name, job title, location, notes, age or gender, and add an email address or phone number.

Add note

Add an internal note to a conversation. Notes are only seen by your team, never by the customer.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
NotetexttextRequired: The note text. Basic HTML is allowed.
Statusstatustext: The conversation status to set. Leave empty to keep it as it is.One of: active, pending, closed.

Outputs

conversation_idnumber
idnumber

Example output

{
  "conversation_id": 123456789,
  "id": 9003
}

Start a conversation in an inbox, with a first message from the customer, a reply from your team, or an internal note. A customer email Help Scout does not know creates the customer. A first message from your team is emailed to the customer.

Inputs

Inboxinbox_idtextRequired: The Help Scout inbox (called a mailbox in older Help Scout pages).
SubjectsubjecttextRequired: The conversation's subject line.
Customer emailcustomer_emailtext: The customer's email address. Required unless you give a customer ID.
Customer IDcustomer_idtext: An existing customer's id, instead of an email.
Customer first namecustomer_first_nametext: Used when the customer is new. Up to 40 characters.
Customer last namecustomer_last_nametext: Used when the customer is new. Up to 40 characters.
First messagemessagetextRequired: The text of the conversation's first message.
First message is frommessage_fromtext: Who wrote the first message. Defaults to the customer.One of: customer (The customer (an incoming message)), reply (Your team (a reply to the customer)), note (Your team (an internal note)).
Channelconversation_typetext: Defaults to Email.One of: email, chat, phone.
Statusstatustext: Defaults to Active.One of: active, pending, closed.
Assign toassign_totext: The teammate to assign the conversation to.
Tagstagstext: Tag names. A tag that does not exist yet is created by Help Scout.
Send auto-replyauto_replytrue/false: Send the inbox's auto-reply to the customer, if it has one.

Outputs

assigneeobject
bcclist
cclist
closed_attext
closed_byobject
created_attext
created_byobject
custom_fieldslist
customer_waiting_sincetext
folder_idnumber
idnumber
inbox_idnumber
numbernumber
previewtext
primary_customerobject
sourceobject
statetext
statustext
subjecttext
tagslist
thread_countnumber
typetext
user_updated_attext
web_urltext

Example output

{
  "assignee": {
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": 301,
    "last_name": "Agent",
    "type": "user"
  },
  "bcc": [],
  "cc": [],
  "closed_at": null,
  "closed_by": null,
  "created_at": "2026-09-01T10:00:00Z",
  "created_by": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "custom_fields": [],
  "customer_waiting_since": "2026-09-01T10:00:00Z",
  "folder_id": 201,
  "id": 123456789,
  "inbox_id": 101,
  "number": 42,
  "preview": "My order has not arrived.",
  "primary_customer": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "source": {
    "type": "email",
    "via": "customer"
  },
  "state": "published",
  "status": "active",
  "subject": "Where is my order?",
  "tags": [
    "shipping"
  ],
  "thread_count": 1,
  "type": "email",
  "user_updated_at": "2026-09-01T10:05:00Z",
  "web_url": "https://secure.helpscout.net/conversation/123456789/42/"
}

Create customer

Add a customer profile with a name, email, phone and other details. Give at least a name or an email.

Inputs

First namefirst_nametext: Up to 40 characters.
Last namelast_nametext: Up to 40 characters.
Emailemailtext: Saved as a work email.
Phonephonetext: Saved as a work phone number.
Job titlejob_titletext: Up to 60 characters.
Locationlocationtext: Up to 60 characters.
Notesbackgroundtext: The Notes field on the customer's profile. Up to 200 characters.
Ageagetext: Free text, such as 34 or 30-35.
Gendergendertext: Leave empty to keep it as it is.One of: male, female, unknown.
Organization IDorganization_idtext: The id of an existing Help Scout organization to link the customer to.

Outputs

agetext
backgroundtext
conversation_countnumber
created_attext
emailtext
emailslist
first_nametext
gendertext
idnumber
job_titletext
last_nametext
locationtext
organization_idnumber
phoneslist
photo_urltext
updated_attext
websiteslist

Example output

{
  "age": "36",
  "background": "Prefers email.",
  "conversation_count": 1,
  "created_at": "2026-08-01T09:00:00Z",
  "email": "ada@example.com",
  "emails": [
    {
      "id": 1,
      "type": "work",
      "value": "ada@example.com"
    }
  ],
  "first_name": "Ada",
  "gender": "female",
  "id": 501,
  "job_title": "Engineer",
  "last_name": "Lovelace",
  "location": "London",
  "organization_id": null,
  "phones": [],
  "photo_url": null,
  "updated_at": "2026-09-01T09:00:00Z",
  "websites": []
}

Delete conversation

Permanently delete a conversation and all of its messages. This cannot be undone.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.

Outputs

deletedtrue/false
idnumber
typetext

Example output

{
  "deleted": true,
  "id": 123456789,
  "type": "conversation"
}

Delete customer

Permanently delete a customer together with all of their conversations and survey responses. There is no undo. Help Scout refuses customers with more than 100 conversations.

Inputs

Customer IDcustomer_idtextRequired: The customer's id - the 'id' of a List customers result, or the number in the address bar of their Help Scout profile.

Outputs

deletedtrue/false
idnumber
typetext

Example output

{
  "deleted": true,
  "id": 501,
  "type": "customer"
}

Get conversation

Read one conversation: subject, status, inbox, customer, assignee, tags, custom fields and a link to open it in Help Scout - optionally with every message and note in it.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
Include messagesinclude_threadstrue/false: Also return every message and note (threads).

Outputs

assigneeobject
bcclist
cclist
closed_attext
closed_byobject
created_attext
created_byobject
custom_fieldslist
customer_waiting_sincetext
folder_idnumber
idnumber
inbox_idnumber
numbernumber
previewtext
primary_customerobject
sourceobject
statetext
statustext
subjecttext
tagslist
thread_countnumber
threadslist
typetext
user_updated_attext
web_urltext

Example output

{
  "assignee": {
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": 301,
    "last_name": "Agent",
    "type": "user"
  },
  "bcc": [],
  "cc": [],
  "closed_at": null,
  "closed_by": null,
  "created_at": "2026-09-01T10:00:00Z",
  "created_by": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "custom_fields": [],
  "customer_waiting_since": "2026-09-01T10:00:00Z",
  "folder_id": 201,
  "id": 123456789,
  "inbox_id": 101,
  "number": 42,
  "preview": "My order has not arrived.",
  "primary_customer": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "source": {
    "type": "email",
    "via": "customer"
  },
  "state": "published",
  "status": "active",
  "subject": "Where is my order?",
  "tags": [
    "shipping"
  ],
  "thread_count": 1,
  "threads": [
    {
      "action_text": null,
      "assigned_to": null,
      "attachments": [],
      "bcc": [],
      "body": "<p>My order has not arrived.</p>",
      "cc": [],
      "created_at": "2026-09-01T10:00:00Z",
      "created_by": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "customer": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "id": 9001,
      "opened_at": null,
      "saved_reply_id": null,
      "source": {
        "type": "email",
        "via": "customer"
      },
      "state": "published",
      "status": "active",
      "to": [],
      "type": "customer"
    }
  ],
  "type": "email",
  "user_updated_at": "2026-09-01T10:05:00Z",
  "web_url": "https://secure.helpscout.net/conversation/123456789/42/"
}

Get current user

Read the Help Scout user this connection acts as - the person who created the app.

Inputs

None.

Outputs

company_idnumber
created_attext
emailtext
first_nametext
idnumber
job_titletext
last_nametext
phonetext
roletext
timezonetext
typetext
updated_attext

Example output

{
  "company_id": 1001,
  "created_at": "2026-01-01T09:00:00Z",
  "email": "sam@example.com",
  "first_name": "Sam",
  "id": 301,
  "job_title": null,
  "last_name": "Agent",
  "phone": null,
  "role": "owner",
  "timezone": "Europe/London",
  "type": "user",
  "updated_at": "2026-09-01T09:00:00Z"
}

Get customer

Read a customer's profile: name, emails, phones, websites, job title, location, notes and how many conversations they have.

Inputs

Customer IDcustomer_idtextRequired: The customer's id - the 'id' of a List customers result, or the number in the address bar of their Help Scout profile.

Outputs

agetext
backgroundtext
conversation_countnumber
created_attext
emailtext
emailslist
first_nametext
gendertext
idnumber
job_titletext
last_nametext
locationtext
organization_idnumber
phoneslist
photo_urltext
updated_attext
websiteslist

Example output

{
  "age": "36",
  "background": "Prefers email.",
  "conversation_count": 1,
  "created_at": "2026-08-01T09:00:00Z",
  "email": "ada@example.com",
  "emails": [
    {
      "id": 1,
      "type": "work",
      "value": "ada@example.com"
    }
  ],
  "first_name": "Ada",
  "gender": "female",
  "id": 501,
  "job_title": "Engineer",
  "last_name": "Lovelace",
  "location": "London",
  "organization_id": null,
  "phones": [],
  "photo_url": null,
  "updated_at": "2026-09-01T09:00:00Z",
  "websites": []
}

List conversation messages

List the messages, replies, notes and activity (threads) in a conversation, with their text, author and time.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The conversation's threads
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "action_text": null,
      "assigned_to": null,
      "attachments": [],
      "bcc": [],
      "body": "<p>My order has not arrived.</p>",
      "cc": [],
      "created_at": "2026-09-01T10:00:00Z",
      "created_by": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "customer": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "id": 9001,
      "opened_at": null,
      "saved_reply_id": null,
      "source": {
        "type": "email",
        "via": "customer"
      },
      "state": "published",
      "status": "active",
      "to": [],
      "type": "customer"
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

List conversations

Find conversations, filtered by inbox, folder, status, tags, assignee, number or last-modified date, or with Help Scout's search syntax. Returns one page of conversations with their subject, status, customer, assignee and tags.

Inputs

Inboxinbox_idtext: Only this inbox. Leave empty for every inbox you can access.
Folderfolder_idtext: Only this folder of the chosen inbox.
Statusstatustext: Which conversations to include. Defaults to Active.One of: active, pending, closed, open, spam, all.
Tagstagstext: Only conversations carrying these tags.
Assigned toassigned_totext: Only conversations assigned to this teammate.
Modified sincemodified_sincedate and time: Only conversations changed on or after this time.
Conversation numbernumbernumber: Only the conversation with this #number.
Searchquerytext: Help Scout search syntax, such as (subject:"refund") or (email:"ada@example.com").
Sort bysort_fieldtext: Defaults to Created.One of: modifiedAt (Last modified), createdAt (Created), waitingSince (Waiting since), number (Conversation number), subject, status, customerName (Customer name), customerEmail (Customer email), mailboxid (Inbox), score (Search relevance).
Sort ordersort_ordertext: Defaults to newest first.One of: desc (Newest / highest first), asc (Oldest / lowest first).
Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The matching conversations
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "assignee": {
        "email": "sam@example.com",
        "first_name": "Sam",
        "id": 301,
        "last_name": "Agent",
        "type": "user"
      },
      "bcc": [],
      "cc": [],
      "closed_at": null,
      "closed_by": null,
      "created_at": "2026-09-01T10:00:00Z",
      "created_by": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "custom_fields": [],
      "customer_waiting_since": "2026-09-01T10:00:00Z",
      "folder_id": 201,
      "id": 123456789,
      "inbox_id": 101,
      "number": 42,
      "preview": "My order has not arrived.",
      "primary_customer": {
        "email": "ada@example.com",
        "first_name": "Ada",
        "id": 501,
        "last_name": "Lovelace",
        "type": "customer"
      },
      "source": {
        "type": "email",
        "via": "customer"
      },
      "state": "published",
      "status": "active",
      "subject": "Where is my order?",
      "tags": [
        "shipping"
      ],
      "thread_count": 1,
      "type": "email",
      "user_updated_at": "2026-09-01T10:05:00Z",
      "web_url": "https://secure.helpscout.net/conversation/123456789/42/"
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

List customers

Find customers by email, name, or Help Scout's search syntax, or those created or changed since a date. Newest first. Pass the result's next cursor to get the following page.

Inputs

Emailemailtext: Only the customer with this email address.
First namefirst_nametext: Up to 40 characters.
Last namelast_nametext: Up to 40 characters.
Searchquerytext: Help Scout search syntax, such as (firstName:"Ada").
Created sincecreated_sincedate and time: Only customers created on or after this time.
Modified sincemodified_sincedate and time: Only customers changed on or after this time.
Next page cursorcursortext: The next_cursor of an earlier List customers result, with the same filters. Leave empty for the first page.

Outputs

countnumber
has_moretrue/false
itemslist: The matching customers
next_cursortext

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "age": "36",
      "background": "Prefers email.",
      "conversation_count": 1,
      "created_at": "2026-08-01T09:00:00Z",
      "email": "ada@example.com",
      "emails": [
        {
          "id": 1,
          "type": "work",
          "value": "ada@example.com"
        }
      ],
      "first_name": "Ada",
      "gender": "female",
      "id": 501,
      "job_title": "Engineer",
      "last_name": "Lovelace",
      "location": "London",
      "organization_id": null,
      "phones": [],
      "photo_url": null,
      "updated_at": "2026-09-01T09:00:00Z",
      "websites": []
    }
  ],
  "next_cursor": null
}

List inbox folders

List an inbox's folders (Unassigned, Mine, Closed and so on) with how many conversations each holds.

Inputs

Inboxinbox_idtextRequired: The Help Scout inbox (called a mailbox in older Help Scout pages).
Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The inbox's folders
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "active_count": 2,
      "id": 201,
      "name": "Unassigned",
      "total_count": 3,
      "type": "open",
      "updated_at": "2026-09-01T09:00:00Z",
      "user_id": 0
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

List inboxes

List the inboxes you can access, with their ids and addresses.

Inputs

Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The inboxes
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "created_at": "2026-01-01T09:00:00Z",
      "email": "support@example.com",
      "id": 101,
      "name": "Support",
      "slug": "a1b2c3d4e5f60718",
      "updated_at": "2026-09-01T09:00:00Z"
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

List saved replies

List an inbox's saved replies, with a preview of each.

Inputs

Inboxinbox_idtextRequired: The Help Scout inbox (called a mailbox in older Help Scout pages).
Include chat repliesinclude_chat_repliestrue/false: Also include saved replies made for chat.

Outputs

countnumber
itemslist: The saved replies

Example output

{
  "count": 1,
  "items": [
    {
      "chat_preview": null,
      "id": 601,
      "name": "Refund policy",
      "preview": "Refunds are issued within 5 days..."
    }
  ]
}

List the account's tags and how many conversations use each.

Inputs

Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The tags
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "conversation_count": 12,
      "created_at": "2026-01-01T09:00:00Z",
      "id": 401,
      "name": "shipping",
      "slug": "shipping",
      "updated_at": "2026-09-01T09:00:00Z"
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

List users

List your Help Scout teammates, optionally only those with access to one inbox or with one email address.

Inputs

Emailemailtext: Only the teammate with exactly this email.
Inboxinbox_idtext: Only this inbox. Leave empty for every inbox you can access.
Pagepagenumber: Which page of results to return, starting at 1.From 1 to 100000. Default: 1.

Outputs

countnumber
has_moretrue/false
itemslist: The teammates
pagenumber
totalnumber
total_pagesnumber

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "created_at": "2026-01-01T09:00:00Z",
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": 301,
      "job_title": null,
      "last_name": "Agent",
      "phone": null,
      "role": "owner",
      "timezone": "Europe/London",
      "type": "user",
      "updated_at": "2026-09-01T09:00:00Z"
    }
  ],
  "page": 1,
  "total": 1,
  "total_pages": 1
}

Reply to conversation

Reply to the customer on a conversation. The reply is emailed to the customer unless it is saved as a draft. Replies to the conversation's primary customer unless you name another.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
ReplytexttextRequired: The reply text. Basic HTML is allowed.
Save as draftdrafttrue/false: Save the reply as a draft instead of sending it.
Statusstatustext: The conversation status to set. Leave empty to keep it as it is.One of: active, pending, closed.
Assign toassign_totext: The teammate to assign the conversation to.
CCcclist: Email addresses to copy on the reply.
BCCbcclist: Email addresses to blind-copy on the reply.
Customer IDcustomer_idtext: The customer to reply to. Leave empty for the conversation's primary customer.

Outputs

conversation_idnumber
customer_idnumber
drafttrue/false
idnumber

Example output

{
  "conversation_id": 123456789,
  "customer_id": 501,
  "draft": false,
  "id": 9002
}

Tag conversation

Add tags to a conversation, remove some, replace them all, or clear them. A tag that does not exist yet is created. Returns the conversation's tags afterwards.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
Tagstagstext: Tag names. A tag that does not exist yet is created by Help Scout.
What to domodetext: Defaults to adding the tags.One of: add (Add these tags, keep the rest), remove (Remove these tags, keep the rest), replace (Replace all tags with these), clear (Remove every tag).

Outputs

conversation_idnumber
modetext
tagslist

Example output

{
  "conversation_id": 123456789,
  "mode": "add",
  "tags": [
    "shipping",
    "vip"
  ]
}

Update conversation

Change a conversation's subject, status, inbox, primary customer or assignee, or unassign it. Only the fields you set are changed. Returns the updated conversation.

Inputs

Conversation IDconversation_idtextRequired: The conversation's id - the 'id' of a List conversations result, or the long number in the address bar when the conversation is open in Help Scout (a pasted address works). Not the short #number.
Subjectsubjecttext: A new subject line.
Statusstatustext: The conversation status to set. Leave empty to keep it as it is.One of: active, pending, closed.
Move to inboxmove_to_inbox_idtext: Move the conversation to this inbox.
Assign toassign_totext: The teammate to assign the conversation to.
Unassignunassigntrue/false: Remove the current assignee.
Primary customer IDcustomer_idtext: Make this customer the conversation's primary customer.

Outputs

assigneeobject
bcclist
cclist
changedlist
closed_attext
closed_byobject
created_attext
created_byobject
custom_fieldslist
customer_waiting_sincetext
folder_idnumber
idnumber
inbox_idnumber
numbernumber
previewtext
primary_customerobject
sourceobject
statetext
statustext
subjecttext
tagslist
thread_countnumber
typetext
user_updated_attext
web_urltext

Example output

{
  "assignee": {
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": 301,
    "last_name": "Agent",
    "type": "user"
  },
  "bcc": [],
  "cc": [],
  "changed": [
    "status"
  ],
  "closed_at": null,
  "closed_by": null,
  "created_at": "2026-09-01T10:00:00Z",
  "created_by": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "custom_fields": [],
  "customer_waiting_since": "2026-09-01T10:00:00Z",
  "folder_id": 201,
  "id": 123456789,
  "inbox_id": 101,
  "number": 42,
  "preview": "My order has not arrived.",
  "primary_customer": {
    "email": "ada@example.com",
    "first_name": "Ada",
    "id": 501,
    "last_name": "Lovelace",
    "type": "customer"
  },
  "source": {
    "type": "email",
    "via": "customer"
  },
  "state": "published",
  "status": "active",
  "subject": "Where is my order?",
  "tags": [
    "shipping"
  ],
  "thread_count": 1,
  "type": "email",
  "user_updated_at": "2026-09-01T10:05:00Z",
  "web_url": "https://secure.helpscout.net/conversation/123456789/42/"
}

Update customer

Change a customer's name, job title, location, notes, age or gender, and add an email address or phone number. Only the fields you set are changed.

Inputs

Customer IDcustomer_idtextRequired: The customer's id - the 'id' of a List customers result, or the number in the address bar of their Help Scout profile.
First namefirst_nametext: Up to 40 characters.
Last namelast_nametext: Up to 40 characters.
Job titlejob_titletext: Up to 60 characters.
Locationlocationtext: Up to 60 characters.
Notesbackgroundtext: The Notes field on the customer's profile. Up to 200 characters.
Ageagetext: Free text, such as 34 or 30-35.
Gendergendertext: Leave empty to keep it as it is.One of: male, female, unknown.
Add emailadd_emailtext: Add this email address as a work email.
Add phoneadd_phonetext: Add this phone number as a work phone.

Outputs

agetext
backgroundtext
changedlist
conversation_countnumber
created_attext
emailtext
emailslist
first_nametext
gendertext
idnumber
job_titletext
last_nametext
locationtext
organization_idnumber
phoneslist
photo_urltext
updated_attext
websiteslist

Example output

{
  "age": "36",
  "background": "Prefers email.",
  "changed": [
    "jobTitle"
  ],
  "conversation_count": 1,
  "created_at": "2026-08-01T09:00:00Z",
  "email": "ada@example.com",
  "emails": [
    {
      "id": 1,
      "type": "work",
      "value": "ada@example.com"
    }
  ],
  "first_name": "Ada",
  "gender": "female",
  "id": 501,
  "job_title": "Engineer",
  "last_name": "Lovelace",
  "location": "London",
  "organization_id": null,
  "phones": [],
  "photo_url": null,
  "updated_at": "2026-09-01T09:00:00Z",
  "websites": []
}

ActionsCopy Anchor Link

Add noteCopy Anchor Link

Inputs

Outputs

Create conversationCopy Anchor Link

Inputs

Outputs

Create customerCopy Anchor Link

Inputs

Outputs

Delete conversationCopy Anchor Link

Inputs

Outputs

Delete customerCopy Anchor Link

Inputs

Outputs

Get conversationCopy Anchor Link

Inputs

Outputs

Get current userCopy Anchor Link

Inputs

Outputs

Get customerCopy Anchor Link

Inputs

Outputs

List conversation messagesCopy Anchor Link

Inputs

Outputs

List conversationsCopy Anchor Link

Inputs

Outputs

List customersCopy Anchor Link

Inputs

Outputs

List inbox foldersCopy Anchor Link

Inputs

Outputs

List inboxesCopy Anchor Link

Inputs

Outputs

List saved repliesCopy Anchor Link

Inputs

Outputs

List tagsCopy Anchor Link

Inputs

Outputs

List usersCopy Anchor Link

Inputs

Outputs

Reply to conversationCopy Anchor Link

Inputs

Outputs

Tag conversationCopy Anchor Link

Inputs

Outputs

Update conversationCopy Anchor Link

Inputs

Outputs

Update customerCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add note

Create conversation

Create customer

Delete conversation

Delete customer

Get conversation

Get current user

Get customer

List conversation messages

List conversations

List customers

List inbox folders

List inboxes

List saved replies

List tags

List users

Reply to conversation

Tag conversation

Update conversation

Update customer