Articles in this section

Available Help Scout APIs

When you configure an export, import, or other type of flow step using the prebuilt Help Scout connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Help Scout API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Conversations

Delete attachment

X

Download attachment file

X

Get attachment data

X

Upload attachment

X

Update custom fields

X

Delete snooze

X

Update snooze

X

Update tags

X

Delete thread schedule

X

Publish thread schedule

X

Update thread schedule

X

Create chat thread

X

Create customer thread

X

Create note

X

Create phone thread

X

Create reply thread

X

Get thread original source

X

List threads

X

Update thread

X

Create conversation

X

Delete conversation

X

Get conversation

X

List conversations

X

Update conversation

X

Customers

Create address

X

Delete address

X

Get address

X

Update address

X

Create chat handle

X

Delete chat handle

X

List chats handles

X

Update chat handles

X

Create email

X

Delete email

X

List emails

X

Update email

X

Create phone

X

Delete phone

X

List phones

X

Update phone

X

Create social profile

X

Delete social profile

X

List social profiles

X

Update social profile

X

Create website

X

Delete website

X

List websites

X

Update website

X

Create customer

X

Delete customer

X

Delete customer asynchronously

X

Get customer

X

List customers

X

Overwrite customer

X

Update customer

X

Inboxes

Get routing configuration

X

Update routing configuration

X

Create saved reply

X

Delete saved reply

X

Get saved reply

X

List saved replies

X

Update saved reply

X

Get inbox

X

List inbox custom fields

X

List inbox folders

X

List inboxes

X

Organizations

Create organization property definition

X

Delete organization property definition

X

Get organization property definition

X

List organization property definitions

X

Remove organization property value

X

Set organization property value

X

Update organization property definition

X

Create organization

X

Delete organization by ID

X

Get organization conversations

X

Get organization customers

X

Get organization by ID

X

List organizations

X

Update organization

X

Properties

Create customer property definition

X

Delete customer property

X

List customer property definitions

X

Update customer properties

X

Ratings

Get satisfaction rating

X

Reports

Company overall report

X

Company customers helped

X

Company drilldown

X

Conversations overall report

X

All channels volumes by channel

X

Conversations busiest time of day

X

Conversations drilldown

X

Conversations drilldown by field

X

New conversations report

X

Conversations new conversations drilldown

X

Conversations received messages statistics

X

Docs overall report

X

Happiness overall report

X

Happiness ratings report

X

Productivity overall report

X

Productivity first response time

X

Productivity replies sent

X

Productivity resolution time

X

Productivity resolved conversations

X

Productivity response time

X

User/team overall report

X

User conversation history report

X

User customers helped

X

User drill down

X

User happiness report

X

User happiness drilldown

X

User replies report

X

User resolutions report

X

User/team chat report

X

Chat report

X

Email report

X

Phone report

X

Tags

Get tag by ID

X

List tags

X

Teams

List team members

X

List teams

X

Users

List users statuses

X

Set user status

X

Delete user

X

Get resource owner

X

Get user

X

List users

X

Webhooks

Create webhook

X

Delete webhook

X

Get webhook

X

List webhooks

X

Update webhook

X

Workflows

List workflows

X

Run manual workflows

X

Update workflow status

X