Logo
SupportHero Logo

SupportHero APIs

Show your knowledge base where your users need it the most, right within your app and reduce the number of incoming support tickets by 50%. Start today!

Developer

SupportHero APIs

Account Request URL

-

Base Endpoint

-

Applications

Get list of Applications

GET

applications

Applications

Create an Application

POST

applications

name, description

Applications

Get a specific Application

GET

applications/{id}

Applications

Update an Application

PUT

applications/{id}

name, description

Applications

Delete an Application

DELETE

applications/{id}

Conversations

Get list of Conversations

GET

conversations

page, per_page, sort_by, sort_order, assigned, updated_since, type, application_id, status, topic, labels

Conversations

Get a specific Conversation

GET

conversations/{id}

Conversations

Update a Conversation

PUT

conversations/{id}

application_id, topic, priority, labels, status, satisfaction_rating

Conversations

Create a Conversation

POST

conversations

application_id, topic, content, attachments, labels, priority

Conversations

Get list of Conversations

GET

conversations

page, per_page, sort_by, sort_order, assigned, updated_since, type, application_id, status, topic, labels

Conversations

Get a specific Conversation

GET

conversations/{id}

Conversations

Update a Conversation

PUT

conversations/{id}

application_id, topic, priority, labels, status, satisfaction_rating

Conversations

Create a Conversation

POST

conversations

application_id, topic, content, attachments, labels, priority

Conversations

Delete a Conversation

DELETE

conversations/{id}

Messages

Create a Message

POST

messages

conversation_id, author_id, content, attachments

Messages

Get list of Messages

GET

messages

page, per_page, sort_by, sort_order, conversation_id

Messages

Get a specific Message

GET

messages/{id}

Users

Get list of Users

GET

users

page, per_page, sort_by, sort_order, organization_id, with_avatar

Users

Create a User

POST

users

name, email, organization_id, password, avatar

Users

Get a specific User

GET

users/{id}

Users

Update a User

PUT

users/{id}

name, email, password, avatar

Users

Delete a User

DELETE

users/{id}

Organizations

Get list of Organizations

GET

organizations

page, per_page, sort_by, sort_order

Organizations

Create an Organization

POST

organizations

name

Organizations

Get a specific Organization

GET

organizations/{id}

Organizations

Update an Organization

PUT

organizations/{id}

name

Organizations

Delete an Organization

DELETE

organizations/{id}

Tags

Get list of Tags

GET

tags

page, per_page, sort_by, sort_order

Tags

Create a Tag

POST

tags

application_id, name

Tags

Get a specific Tag

GET

tags/{id}

Tags

Update a Tag

PUT

tags/{id}

name

Tags

Delete a Tag

DELETE

tags/{id}

Labels

Get list of Labels

GET

labels

page, per_page, sort_by, sort_order

Labels

Create a Label

POST

labels

application_id, name

Labels

Get a specific Label

GET

labels/{id}

Labels

Update a Label

PUT

labels/{id}

name

Labels

Delete a Label

DELETE

labels/{id}

SatisfactionRatings

Get list of SatisfactionRatings

GET

satisfaction_ratings

page, per_page, sort_by, sort_order

SatisfactionRatings

Create a SatisfactionRating

POST

satisfaction_ratings

conversation_id, rating, comment

SatisfactionRatings

Get a specific SatisfactionRating

GET

satisfaction_ratings/{id}

SatisfactionRatings

Update a SatisfactionRating

PUT

satisfaction_ratings/{id}

rating, comment

SatisfactionRatings

Delete a SatisfactionRating

DELETE

satisfaction_ratings/{id}

Roles

Get list of Roles

GET

roles

page, per_page, sort_by, sort_order, organization_id

Roles

Create a Role

POST

roles

name, organization_id

Roles

Get a specific Role

GET

roles/{id}

Roles

Update a Role

PUT

roles/{id}

name

Roles

Delete a Role

DELETE

roles/{id}

Triggers

Get list of Triggers

GET

triggers

page, per_page, sort_by, sort_order, application_id, event_type

Triggers

Create a Trigger

POST

triggers

application_id, event_type, payload, actions

Triggers

Get a specific Trigger

GET

triggers/{id}

Triggers

Update a Trigger

PUT

triggers/{id}

payload, actions

Triggers

Delete a Trigger

DELETE

triggers/{id}

Integrations

Get list of Integrations

GET

integrations

page, per_page, sort_by, sort_order, application_id, type

Integrations

Create an Integration

POST

integrations

type, application_id, config

Integrations

Get a specific Integration

GET

integrations/{id}

Integrations

Update an Integration

PUT

integrations/{id}

config

Integrations

Delete an Integration

DELETE

integrations/{id}

Events

Get list of Events

GET

events

page, per_page, sort_by, sort_order, application_id, event_type

Events

Get a specific Event

GET

events/{id}

Details

Provider

Country HQ

US

API Type

REST

Categories

Knowledge Base

Alternatives

Important URLs

Last Updated on

2024-04-04

Created At

2023-12-14

Other Apps

Upskill for a better future

Want to start tracking API at scale?

Get updates about your favorite APIs and SDKs

Contact Us

We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.

ApiRefs Logo