---
title: "Run a platform helper tool"
method: POST
path: "/api/v1/platforms/trigger"
tags: ["Platforms"]
---

# Run a platform helper tool

`POST /api/v1/platforms/trigger`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/platforms/trigger`
- Auth: HTTP bearer

## Request body

- PlatformTriggerRequest
  - `helper` 'linkedin.recent_mentions' | 'pinterest.boards' | 'tiktok.creator_info' | 'x.quota', required
  - `account_id` string, nullable
  - `platform` string, nullable
  - `params` object, nullable

## Response `200`

Platform helper completed

- PlatformTriggerResponse
  - `helper` string, required
  - `account` object, nullable
  - `result` unknown, required

## Other responses

- `400`: Validation error
- `401`: Invalid or missing API key
- `403`: The account belongs to a workspace where the caller is below the Editor role. Helpers read or refresh the account token, so they need Editor or higher. The body carries `code: insufficient_workspace_permissions` and `required_role: editor`.
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)