POST Create Custom Engagement Task

Create Custom Engagement Task Shop Required scope: seller.customer_engagement.write Create an engagement task that uses a self-defined custom message instead of predefined message templates from TikTok Shop. The task acts as a container for grouping messages with similar content and rules, allowing sellers to track and compare task performance across different types of content. Note that each task has a mandatory end time, and once expired, it cannot be used to send additional messages. Version 202502

POST/customer_engagement/202502/engagement_tasks/custom

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.
idempotency_key Required	string	A unique key to recognize a request and prevent duplicate processing of the same request, especially in cases of connection issues. Ensure this key is unique for each request to avoid accidental duplicates.Note: We recommend that you generate v4 UUIDs for use as keys.
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
task_name Required	string	The name of the task.
end_time Required	int	The time at which the task ends, and messages will no longer be sent. Unix timestamp (seconds).
channel Required	string	The engagement channel. Only TIKTOK_IM is supported.
product_ids	[]string	The product IDs that you want to include as interactive cards in the message. Retrieve this value from the Search Products API.Max count: 4
coupon_ids	[]string	The coupon IDs that you want to include as interactive cards in the message. Max count: 1You can only add coupons that have one of these sets of property:- coupons.display_type=REGULAR and coupons.target_buyer_segment=ALL- coupons.display_type=REGULAR and coupons.target_buyer_segment=REPEAT_CUSTOMERS.Find out the coupon ID and properties from the Search Coupons API.
custom_message	object	The custom message to send to customers.

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 | | --- | --- | | 68008004 | Policy violation. The message contains content that violates TikTok Shop policies. Modify it and try again. | | 68008016 | You're currently ineligible to send customized messages. Please use a message template. | | 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. | | 68009005 | Failed to create an engagement task. Error details: |

Is this content helpful?Helpful

Not Helpful

PreviousNext