Get Message Templates

GET

/customer_engagement/202412/message_templates

Get a library of customer engagement message templates predefined by TikTok Shop, which you can use directly in your customer engagement communications.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

locale

required

string

The BCP-47 locale codes for displaying the message content, delimited by commas.

Refer to Locale codes for the list of supported locale codes.

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

message_templates

Customer engagement message templates predefined by TikTok Shop.

Array<object>

object

id

The template ID.

string

message_title

The message title.

string

message_body

The message body.

string

product_card_rules

Rules on the number and type of interactive product cards that can be included in a message.

object

min_count

The minimum number of product cards that must be included.

integer format: int64

max_count

The maximum number of product cards that can be included.

integer format: int64

coupon_card_rules

Rules on the number and type of interactive coupon cards that can be included in a message.

object

min_count

The minimum number of coupon cards that must be included.

integer format: int64

max_count

The maximum number of coupon cards that can be included.

integer format: int64

coupon_type

The types of coupon that can be included in the message. Possible values:

• REGULAR_ALL: Regular coupons that target all buyers. Required coupon properties: coupons.display_type=REGULAR and coupons.target_buyer_segment=ALL in the Search Coupons API.
• REGULAR_REPEAT: Regular coupons that target only repeat buyers. Required coupon properties: coupons.display_type=REGULAR and coupons.target_buyer_segment=REPEAT_CUSTOMERS in the Search Coupons API.

Array<string>

Allowed values: REGULAR_ALL REGULAR_REPEAT

Example

{
  "code": 0,
  "data": {
    "message_templates": [
      {
        "id": "123456789_987654321",
        "message_title": "Meet your next favorite thing!",
        "message_body": "We strive to create products with you in mind. Check out our newest drop to find your perfect fit that’s built for a confidence boost.",
        "product_card_rules": {
          "min_count": 0,
          "max_count": 4
        },
        "coupon_card_rules": {
          "min_count": 1,
          "max_count": 1,
          "coupon_type": [
            "REGULAR_ALL",
            "REGULAR_REPEAT"
          ]
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}