Platforms
Get platform schema for a connected account
get/api/v1/accounts/{id}/schema
Request
- Base URL: https://www.poster.ly
- URL: https://www.poster.ly/api/v1/accounts/{id}/schema
- Auth: HTTP bearer
Path parameters
idstring required
Connected social account ID
Response
Account platform schema fetched successfully
Example response
{
"account": {
"id": "123",
"platform": "pinterest",
"username": "posterly"
},
"schema": {
"id": "pinterest",
"aliases": [],
"label": "Pinterest",
"status": "supported",
"summary": "Publish image Pins, video Pins, and multi-image Pins with board selection and destination-link support.",
"content_limit": 800,
"media": {
"min": 1,
"max": 5,
"images_max": 5,
"videos_max": 1
},
"post_types": [
"image",
"video",
"carousel"
],
"analytics_supported": true,
"settings_schema": {
"fields": [
{
"key": "board_id",
"type": "string",
"aliases": [
"pinterest_board_id"
],
"required": true,
"description": "Pinterest board ID from the pinterest.boards helper."
},
{
"key": "title",
"type": "string",
"description": "Pinterest Pin title."
},
{
"key": "link",
"type": "string",
"aliases": [
"destination_url"
],
"description": "Destination URL for the Pin."
},
{
"key": "cover_image_url",
"type": "string",
"aliases": [
"video_cover_url",
"pinterest_cover_image_url"
],
"description": "Required for video Pins: a stored, probe-verified JPEG or PNG cover URL (20 MiB maximum)."
},
{
"key": "ai_generated",
"type": "boolean",
"aliases": [
"ai_disclosure"
],
"description": "Label the Pin as AI-modified (ai_disclosures)."
},
{
"key": "product_tags",
"type": "array",
"description": "Optional product tags on POST /v5/pins (product_id, optional x/y). Existing pins:write. Pin note is not written."
},
{
"key": "media_alt_texts",
"type": "object",
"aliases": [
"alt_texts"
],
"description": "Legacy map of source media URLs to alt text. Still accepted for backwards compatibility."
},
{
"key": "media_accessibility",
"type": "array",
"description": "Ordered media accessibility entries: { index, asset_id?, source_url?, alt_text }. Preferred because identity survives platform media preparation."
}
],
"example": {
"board_id": "123456789",
"title": "Launch ideas",
"link": "https://www.poster.ly",
"cover_image_url": "https://assets.poster.ly/users/123/pinterest-video-covers/cover.jpg",
"product_tags": [
{
"product_id": "123"
}
]
}
},
"helper_tools": [
{
"name": "pinterest.boards",
"status": "available",
"description": "List cached Pinterest boards for the connected account.",
"requires_account": true,
"input_schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
],
"native_features": [
"Board selection",
"Multi-image Pins (2 to 5 images)",
"Single image and video Pins",
"Custom video Pin cover",
"Destination URL support",
"Product tags",
"AI-modified content label"
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.