Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

socialAccountPostId
string
required

The socialAccountPostId of a social account post, from List social account posts or from the socialAccountPosts of Get post.

Body

application/json

The fields to change. Each field you send replaces that whole field. Fields you omit stay unchanged. At least one field is required.

content
object[]

The social account post's new content.

Required array length: 1 element
schedule
Draft · object

The social account post's new schedule.

Response

Social account post updated.

platform
enum<string>
required

Identifies which social media platform this data structure targets.

Available options:
PINTEREST
socialAccountPostId
string
required

Social account post identifier.

postId
string
required

Parent post identifier.

projectId
string
required

Project identifier.

socialAccountId
string
required

Connected social account identifier.

deliveryStatus
enum<string>
required

Delivery lifecycle status for a post.

NOT_STARTED: The post exists and is scheduled, but delivery has not started yet. SENDING: Delivery is currently in progress. PUBLISHED: Delivery completed successfully. FAILED: Delivery completed unsuccessfully.

Available options:
NOT_STARTED,
SENDING,
PUBLISHED,
FAILED
content
object[]
required

Content for this social account post.

Required array length: 1 element
schedule
Draft · object
required

Schedule for this social account post.

createdAt
string<date-time>
required

UTC time when the social account post was created.

updatedAt
string<date-time>
required

UTC time when the social account post was last updated.

metrics
object
required

Latest stored lifetime totals of a social account post. A metric is omitted when the platform does not report it or nothing has been collected yet. Zero is a recorded value, not missing data.

analytics
object
required
deprecated

Deprecated: use metrics, which holds the same latest values as plain numbers.

Latest stored lifetime metrics for this social account post. Each supported metric contains its latest snapshot, or an empty array if no observation exists. Unsupported metrics are omitted; unsupported platforms and post types return an empty object. Zero is a recorded value, not missing data.

Metrics are collected asynchronously and can have different snapshot dates. Reading posts does not refresh analytics. Arrays allow future snapshot ranges without changing the response shape; date-range queries are not currently supported.

pinterestBoardId
string
required

Identifier of the board to pin to.

deliveryCompletedAt
string<date-time>

UTC time when the latest delivery attempt for this social account post completed both for successful (PUBLISHED) and unsuccessful (FAILED) terminal deliveryStatus values.

externalPostId
string
externalPostUrl
string<uri>
errorMessage
string
metricsCollectedAt
string<date-time>

Oldest UTC collection time among metrics, so every value is at least this fresh. Omitted when metrics is empty.

title
string

Destination URL to attach to the Pin.

Maximum string length: 2048