Set or clear the TikTok ad identity
curl --request PUT \
--url https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identityId": "<string>"
}
'import requests
url = "https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity"
payload = { "identityId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({identityId: '<string>'})
};
fetch('https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"identityId": "<string>",
"identityType": "TT_USER",
"onlyShowAsAds": true,
"identityAuthorizedBcId": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Storefronts
Set or clear the TikTok ad identity
Set or clear the TikTok identity used as this connected advertiser account’s ad identity, and whether the creative shows only as an ad. TikTok-only.
PUT
/
storefront-connections
/
{connectionId}
/
accounts
/
{accountId}
/
identity
Set or clear the TikTok ad identity
curl --request PUT \
--url https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identityId": "<string>"
}
'import requests
url = "https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity"
payload = { "identityId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({identityId: '<string>'})
};
fetch('https://api.apostra.com/api/v2/buyer/storefront-connections/{connectionId}/accounts/{accountId}/identity', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"identityId": "<string>",
"identityType": "TT_USER",
"onlyShowAsAds": true,
"identityAuthorizedBcId": "<string>"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Storefront connection ID
Storefront connection account ID
Body
application/json
TikTok identity id already linked to this advertiser account, from the identities returned for this connection. Null clears the selection.
Minimum string length:
1Whether the creative shows only as an ad, never organically on the linked account's public profile. Defaults to true when first set.