POST Send Engagement Message
Send Engagement Message Shop Required scope: seller.customer_engagement.write Send messages to specific customers for a particular engagement task. Version 202412
POST/customer_engagement/202412/messages
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Body
| Properties | Type | Description |
|---|---|---|
| buyer_emails Required | []string | The anonymized email address of the buyer. Retrieve this value from the Get Order Details API.Note: You can only send messages to buyers who have placed at least one order with the shop in the past 365 days. |
| task_id | string | The ID of the associated customer engagement task. Use the value returned when you call the Create Engagement Task API.Note: Ensure the task is still active. You cannot send messages to tasks that have ended. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 68009001 | Access denied. This endpoint is not available for this shop as the seller does not meet the access criteria for CRM features. See TikTok Shop Academy for details. | | 68009002 | The specified task has ended, and sending of messages is no longer allowed. | | 68009003 | The user adresss is invalid | | 68009004 | Unable to send messages to the specified buyer email as the buyer has not placed an order with the shop in the past 365 days. |
Is this content helpful?Helpful
Not Helpful
PreviousNext