Posts

Set external release ID on a post

Store or repair an external release_id and optional group_id on the post metadata. Useful for agent workflows that need to relink scheduled content to a campaign/release.

put/api/v1/posts/{id}/release-id

Request

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

Path parameters

idinteger required

Post ID

Request body

release_idstring required

External release ID to store on the post metadata.

group_idstring nullable

Optional external group ID to store as api_group_id.

Example request

{
  "release_id": "launch-2026-05-16",
  "group_id": "campaign-42"
}

Response

Release ID updated successfully

release_idstring required
group_idstring nullable

Example response

{
  "post": {
    "id": 971,
    "content": "Launch notes are live.",
    "status": "scheduled",
    "scheduled_at": "2026-03-20T10:00:00.000Z",
    "social_account_id": 123,
    "metadata": {
      "release_id": "launch-2026-05-16",
      "api_group_id": "campaign-42"
    },
    "created_at": "2026-03-19T10:00:00.000Z",
    "updated_at": "2026-03-19T10:05:00.000Z"
  },
  "release_id": "launch-2026-05-16",
  "group_id": "campaign-42"
}

Changes

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