Accounts & connections · Connect
Sets a default Pinterest board.
https://api.pozy.ai/v1/accounts/{accountId}/pinterest-boardsGuides: Pinterest, Headless selection
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
accountIdrequired | string |
Request body
application/json, required
defaultBoardIdstringrequireddefaultBoardNamestring
Example
curl -X PUT "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/pinterest-boards" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"defaultBoardId": "6487bc0cd1959991a058ef1d"
}'const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/pinterest-boards", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
defaultBoardId: "6487bc0cd1959991a058ef1d"
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.put(
"https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/pinterest-boards",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"defaultBoardId": "6487bc0cd1959991a058ef1d",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
messagestringaccountobject19 child fields
_idstringrequiredplatformstringrequiredOne of
tiktok,instagram,facebook,youtube,linkedin,twitter,threads,pinterest,reddit,bluesky,googlebusiness,telegram,snapchat,discord,slack,whatsapp,shopify,wordpress,wix,linkedinads,metaads,pinterestads,tiktokads,xadsand 15 more.profileIdstring or objectrequiredOne of:
string
Profile (11 fields)
_idstringuserIdstringnamestringdescriptionstringcolorstringtimezonestringCan be null.
externalIdstringCan be null.
isDefaultbooleanisOverLimitbooleanaccountCountintegercreatedAtstring (date-time)
usernamestringdisplayNamestringplatformUserIdstringscopeAreasarray of stringCan be null.
oauthAppIdstringCan be null.
tiktokAccountTypestringOne of
business,personal,unknown.profilePicturestringCan be null.
profileUrlstringisActivebooleanrequiredneedsReconnectionbooleanfollowersCountnumberfollowersLastUpdatedstring (date-time)parentAccountIdstringCan be null.
enabledbooleanrateLimitedUntilstring (date-time)Can be null.
metadataobject
{
"message": "Hello from Pozy",
"account": {
"_id": "635d87e261ae344ef27fd1df",
"platform": "tiktok",
"profileId": "6a0b6573846efc28aaa9a3ff",
"username": "acme",
"displayName": "Acme",
"platformUserId": "60c5beb6ca4037bb9ff5117a",
"scopeAreas": [
"string"
],
"oauthAppId": "629a39de8c0a63af5a05067c",
"tiktokAccountType": "business",
"profilePicture": "string",
"profileUrl": "https://pozy.ai/media/example-1.jpg",
"isActive": true,
"needsReconnection": true,
"followersCount": 12.5,
"followersLastUpdated": "2026-10-02T09:00:00.000Z",
"parentAccountId": "6ce971ffa48fe63468db336b",
"enabled": true,
"rateLimitedUntil": "2026-10-02T09:00:00.000Z",
"metadata": {}
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.