Deactivate Activity

POST

/promotion/202309/activities/{activity_id}/deactivate

Deactivate an ongoing or upcoming activity.

Authorizations

• accessToken

Parameters

Path Parameters

activity_id

required

string

A unique ID that identifies different activities.

Query Parameters

shop_cipher

required

string

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

Request Body

Media typeapplication/json

object

Example

{}

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

activity_id

A unique ID that identifies different activities.

string

title

Activity name (50 characters max.) The name must be unique.

string

status

Activity status after successful deactivation. Possible value:

• DEACTIVATED: The activity has been deactivated by the seller and is not available to TikTok users.

string

update_time

The time when the deactivation response was created, as a Unix timestamp in seconds.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "activity_id": "7136104329798256386",
    "title": "FlashSale 20230707",
    "status": "DEACTIVATED",
    "update_time": 1661756811
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}