Posts Api Service

Update an existing scheduled post.

put/v2/scheduler/posts/{id}

Request

  • Base URL: https://app.metricool.com/api
  • URL: https://app.metricool.com/api/v2/scheduler/posts/{id}
  • Auth: none declared

Path parameters

idinteger required

id of the post to update

Request body

idinteger
textstring required
firstCommentTextstring
mediastring[]
autoPublishboolean
saveExternalMediaFilesboolean
mediaAltTextstring[]
shortenerboolean
draftboolean
videoCoverMillisecondsinteger
videoThumbnailUrlstring
parentIdinteger
brandNamestring
targetBrandIdinteger
descendantsScheduledPost[] circular
hasNotReadNotesboolean
uuidstring
copiedFromstring
creatorUserMailstring
creatorUserIdinteger
creatorAgencyUserMailstring
creatorAgencyIdinteger
creatorAgencyUserIdinteger
libraryPostIdinteger
performanceDashboardIdsinteger[]
brandTagIdsinteger[]

Ids of the brand tags to apply: absent keeps the current ones, empty removes them all, a list replaces them. Ids that are not live tags of the brand are ignored; at most 20.

Example request

{
  "tiktokData": {
    "articleLink": {
      "url": "https://www.efe.com/article",
      "title": "Check this out"
    }
  },
  "notes": [
    {
      "mentions": [
        {
          "userId": 12345,
          "agencyId": 37,
          "agencyUserId": 156
        }
      ],
      "mentionId": "a:37:156"
    }
  ],
  "brandTags": [
    {
      "id": 123,
      "name": "Summer 2026",
      "color": "#4A90E2"
    }
  ]
}

Response

OK

metadataobject

Example response

{
  "data": {
    "tiktokData": {
      "articleLink": {
        "url": "https://www.efe.com/article",
        "title": "Check this out"
      }
    },
    "notes": [
      {
        "mentions": [
          {
            "userId": 12345,
            "agencyId": 37,
            "agencyUserId": 156
          }
        ],
        "mentionId": "a:37:156"
      }
    ],
    "brandTags": [
      {
        "id": 123,
        "name": "Summer 2026",
        "color": "#4A90E2"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.