POST Edit Affiliate Partner Campaign

Edit Affiliate Partner Campaign Asset Required scope: partner.tap_campaign.write This API offers the ability to edit an Affiliate Partner campaign. No editing after the campaign is closed. Version 202405

POST/affiliate_partner/202405/campaigns/{campaign_id}/partial_edit

Request

Path

Properties	Type	Description
campaign_id Required	string	The ID of the campaign.

Header

Properties	Type	Description
content-type Required	string	Allowed type: application/json
x-tts-access-token Required	string	The partner access_token value from Get Access Token, when user_type = 3. Follow this guide to get partner 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.
category_asset_cipher Required	string	The partner identifier used in API requests. Retrieve this value by using the [Get Authorized Category Assets API] (https://partner.tiktokshop.com/docv2/page/666012dd609d4402cc3be995).

Body

Properties	Type	Description
name	string	The campaign name. The campaign name must be less than 50 characters.
description	string	The campaign description. The campaign description must be less than 1000 characters.
campaign_start_time	int	The scheduled start time in Unix epoch time format for the campaign. Note that this field can be updated when the campaign status is set to READY or UPCOMING only.
campaign_end_time	int	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.
registration_start_time	int	The scheduled start time in Unix epoch format for seller product registration. Note that this field can be updated when the campaign status is set to READY or UPCOMING only.
registration_end_time	int	The scheduled end time in Unix epoch time format for seller product registration. This field is no longer editable when the campaign status is set to CLOSED.
commission_rate	int	The total commission rate in hundreds of a percent (0.01%) units proposed by the affiliate partner for display to sellers. Commission rate must be greater than 100 and less than 8000.
contact_info	object	The partner's contact information.
target_shop_codes	[]string	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.
target_seller_types	[]string	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

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 | | --- | --- | | 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. | | 16032002 | Invalid campaign period | | 16032003 | Invalid registration period | | 16032004 | Invalid campaign seller scope | | 16032005 | Campaign not found | | 16032007 | Permission denied | | 16032008 | Operation denied |

Is this content helpful?Helpful

Not Helpful

PreviousNext