Skip to main content

PUT Update Target Collaboration

Update Target Collaboration Shop Required scope: seller.affiliate_collaboration.write This API is used by Seller to update STANDARD target collaboration. Version 202508

PUT/affiliate_seller/202508/target_collaborations/{target_collaboration_id}

Request

Path

PropertiesTypeDescription
target_collaboration_id RequiredstringThe unique id of specific target collaboration.

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

PropertiesTypeDescription
name RequiredstringThe name of the target collaboration.
end_time RequiredstringThe end time of the target collaboration.
products Required[]objectThe information about the products provided by the seller for target collaboration with creators in the target collaboration.The maximum number of products is 100.When a product is deleted from the product list, if the deleted product has been added to the showcase by the creator, it will take effect at 0:00 the next day, otherwise it will take effect immediately.
creator_user_open_ids Required[]stringThe list of Creators' TikTok User Open IDs invited in the target collaboration. The maximum number of creators is 50. More details
seller_contact_info RequiredobjectContact information for the seller in the target collaboration.
free_sample_rule RequiredobjectThe free sample rules set by the seller in the target collaboration.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 16024004 | test account and non test account can not cross invite | | 16024006 | The seller cannot invite their official creator. | | 16024008 | There are products that do not belong to this merchant. | | 16024016 | The invitation failed because the creator is already linked with a shop account. | | 16024018 | seller can not invite his block creator | | 16024019 | in sufficient quota to create invitation | | 16024020 | remove excluded creators to create invitation | | 16024021 | invitation contains creator exceed follower limit | | 36009007 | request timeout | | 50001701 | target collaboration has expired | | 50001702 | Your invitation target contains an unavailable creator or product. Please check your request params.Remove the unavailable creator or product id and try again. | | 50001703 | The request parameters contain sensitive words. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 98001004 | Parameter {param_name} is invalid. Reason: {reason}. Expected: {expected_value} |

Is this content helpful?Helpful

Not Helpful

PreviousNext