Shopify Messaging API Reference
A list of the Shopify Messaging API endpoints and their parameters.
Create a new conversation
Anchor link to section titled "Create a new conversation"Create a new conversation with at least one participant.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 201 - Conversation was created.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
topic |
The conversation's topic. | string |
||
source_type |
The source of the conversation: email, sms, messages. |
string |
||
avatar |
||||
urls |
An array of URL paths to the message avatars. | [string] |
||
initials |
A single character representing the conversation avatar. | string |
||
masks |
||||
group |
The type of participant. | string |
||
name |
A String that defines the group’s name. | string |
||
avatar |
The group's avatar URL. | string |
||
participants |
||||
id |
The participant's ID. | string |
||
shopify_user_id |
The participant's Shopify user ID. | integer |
||
nameRequired |
The participant's name. | string |
||
avatar |
The participant's avatar URL path. | string |
||
groupRequired |
The participant's group. | string |
||
customer_id |
The customer's ID. | integer |
||
Update a conversation
Anchor link to section titled "Update a conversation"Update a conversation with at least one participant.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 200 - OK.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
topic |
The conversation's topic. | string |
||
Add a participant to a conversation
Anchor link to section titled "Add a participant to a conversation"Add a participant to a conversation.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 201 - Participant was added to the conversation.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
id |
The participant's ID. | string |
||
shopify_user_id |
The participant's Shopify user ID. | integer |
||
nameRequired |
The participant's name. | string |
||
avatar |
The participant's avatar URL path. | string |
||
groupRequired |
The participant's group. | string |
||
customer_id |
The customer's ID. | integer |
||
Create a new message on a conversation
Anchor link to section titled "Create a new message on a conversation"Create a new message on an existing conversation.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 201 - Message was created.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
sender_id |
The message sender ID. | string |
||
shopify_user_id |
The Shopify user ID of the message sender. | integer |
||
dedupe_key |
A unique nonce identifier. Messages sent with an existing dedupe key are ignored. | string |
||
automated |
Whether the message is automated or not. Automated messages do not trigger push notifications on the Inbox app. | boolean |
||
content |
||||
textRequired |
The new message content. | string |
||
Notify user when a conversation is seen
Anchor link to section titled "Notify user when a conversation is seen"Send a notification to the user when a buyer has seen a conversation.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 200 - OK.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
participant_id |
The participant's ID. | string |
||
seen_timestamp |
The date and time when the conversation was seen. | string |
||
Send delivery confirmation details for a message
Anchor link to section titled "Send delivery confirmation details for a message"Send delivery confirmation details for a given message.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 202 - Confirmation was accepted.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
conversation_id |
The ID of the conversation that contains the message. | string |
||
id |
The message ID. | string |
||
delivery_confirmation_details |
||||
delivered |
Whether the message was delivered. | boolean |
||
delivery_timestamp |
The date and time when the message was delivered. | string |
||
details |
A string describing an error in the event that the message couldn't be delivered. | string |
||
Remove a participant from a conversation
Anchor link to section titled "Remove a participant from a conversation"Remove a participant from a conversation.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 204 - Participant was removed from the conversation.
Create an automated message
Anchor link to section titled "Create an automated message"Create a "greeting" or "away "automated message. The automated greeting message is sent to a buyer when they first message a store. If a store has set business hours and a buyer sends a message to the store outside of the business hours, then the away message is sent.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 200 - OK.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
id |
The ID of the automated message:greeting, away. |
string |
||
automated_message |
||||
content |
The automated message's content. | boolean |
||
Remove an automated message
Anchor link to section titled "Remove an automated message"Remove a "greeting" or "away" automated message.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 200 - OK.
JSON request body
Anchor link to section titled "JSON request body"
| Parameter | Description | Type | ||
|---|---|---|---|---|
id |
The ID of the automated message: greeting, away. |
string |
||
Fetch shop availability
Anchor link to section titled "Fetch shop availability"Fetches a shop's business hours and timezone.
HTTP request
Anchor link to section titled "HTTP request"
Expected HTTP status response: 200 - OK.
If a shop's availability is set to always available:
If a shop's availability specifies days: