Send Engagement Message

POST

/customer_engagement/202412/messages

Send messages to specific customers for a particular engagement task.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

Request Body^required

Media typeapplication/json

object

buyer_emails

required

The anonymized email addresses of the buyers. Retrieve these values from the Get Order Details API.

Provide 1 to 50 addresses per request.

Note: You can only send messages to buyers who have placed at least one order with the shop in the past 365 days.

Array<string>

task_id

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.

string

Example

{
  "buyer_emails": [
    "v43424bDOUSGKQQ7YLNEGXPED3CNCQO24@scs.tiktokw.us",
    "v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us"
  ],
  "task_id": "1381478460934"
}

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

errors

The list of per-buyer validation or eligibility errors.

Array<object>

object

code

The error code.

integer format: int64

message

The error message.

string

detail

The details of the error.

object

buyer_email

The anonymized buyer email address associated with the error.

string

Example

{
  "code": 0,
  "data": {
    "errors": [
      {
        "code": 68009003,
        "message": "The user adresss is invalid",
        "detail": {
          "buyer_email": "v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us"
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}