Posts

Change client approval

Owner or admin only. The actor is the API key user, never a brand guest. action request emails brand reviewers and sends approval.requested. approve, request_changes, and reject are team-side decisions that reuse the client portal approval state machine and send the matching approval.* webhook with signed_in_via agency_api. request_changes requires note. Publishers, editors, and viewers are refused.

post/api/v1/posts/{id}/approval

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/posts/{id}/approval
  • Auth: HTTP bearer

Path parameters

idinteger required

Post ID

Request body

action'request' | 'approve' | 'request_changes' | 'reject' required
axis'asset' | 'caption'

Which axis to decide. Omit for both. Not allowed with action request.

notestring

Required for request_changes. comment is accepted as an alias.

Example request

{
  "action": "request_changes",
  "axis": "caption",
  "note": "Please shorten the first line."
}

Response

Approval updated

action'request' | 'approve' | 'request_changes' | 'reject' required
axis'asset' | 'caption' nullable
approval_statusstring nullable
post_idsinteger[]
actor'agency_api' required
signed_in_via'agency_api' nullable
notified_reviewersinteger
reviewer_countinteger
held_back_post_idsinteger[]

Example response

{
  "action": "request",
  "axis": null,
  "approval_status": "pending_client",
  "post_ids": [
    971
  ],
  "actor": "agency_api",
  "notified_reviewers": 1,
  "reviewer_count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.