Partially updates an Affiliate Partner campaign. Fields omitted from the request retain their current values, including omitted fields within contact_info. target_seller_types and target_shop_codes are mutually exclusive. To switch targeting modes, send the previously used field as an empty array and the new field with its values. Campaigns cannot be edited after they are closed.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The campaign ID in decimal integer format.
Query Parameters
Section titled “Query Parameters”The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.
Request Body
Section titled “Request Body”object
The campaign name. It must contain 1 to 50 characters and must not start with a space.
The campaign description. It must contain 1 to 1000 characters and must not start with a space.
The scheduled campaign start time as a Unix timestamp in seconds. This field can be updated only when the campaign status is READY or UPCOMING.
The scheduled end time in Unix epoch time format for the campaign. Note that the end time must be less than 360 days from the start date. This field is no longer editable when the campaign status is set to CLOSED.
The scheduled start time for seller product registration, as a Unix timestamp in seconds. This field can be updated only when the campaign status is READY or UPCOMING.
The scheduled end time for seller product registration, as a Unix timestamp in seconds. This field is no longer editable when the campaign status is CLOSED.
The total commission rate, in units of 0.01%, proposed by the affiliate partner for display to sellers. The value must be between 100 and 8000, inclusive.
The partner’s contact information.
object
The partner’s phone number registered in WhatsApp, in E.164 international format. Applicable if the target market is MY, SG, GB, ID, or US.
The partner’s email address.
The partner’s phone number in E.164 international format.
The partner’s phone number registered in Zalo, in E.164 international format. Applicable if the target market is VN.
The partner’s phone number registered in Viber, in E.164 international format. Applicable if the target market is PH.
The partner’s phone number registered in LINE, in E.164 international format. Applicable if the target market is TH.
A list of TikTok Shop seller shop codes to allow to register for the campaign. The seller shop code in available in TikTok Shop Seller Central by clicking on the Seller Profile icon in the top right of the user interface. The list must be less than 100 items in length.
A list of eligible seller types to allow to register for the campaign. Use this field to broadly target types of sellers instead of specific sellers in the target_shop_codes field. This is an enumerated type with possible values:
- LOCAL
- CROSS_BORDER
Example
{ "name": "test campaign", "description": "campaign for api test.", "campaign_start_time": 1712941200, "campaign_end_time": 1715878799, "registration_start_time": 1712941200, "registration_end_time": 1713891599, "commission_rate": 1000, "contact_info": { "whatsapp": "+14255550100", "email": "123456@gmail.com", "phone": "+14255550100", "zalo": "+14255550100", "viber": "+14255550100", "line": "+14255550100" }, "target_shop_codes": [ "THCBELNL4Y" ], "target_seller_types": [ "CROSS_BORDER" ]}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Example
{ "code": 0, "data": {}, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}