---
title: "Sync inbox data for an account"
method: POST
path: "/api/v1/inbox/sync"
tags: ["Inbox"]
---

# Sync inbox data for an account

`POST /api/v1/inbox/sync`

## Request

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

Pull the latest Instagram, Facebook Page, Threads, or LinkedIn Page inbox data for one connected account. Honors a 30-second cooldown (60 seconds for LinkedIn). Threads and LinkedIn are comments only. Requires posts:write, a Pro plan or higher, and editor workspace access.

## Request body

- object
  - `account_id` integer, required
  - `sync_type` 'all' | 'dm' | 'comments'
  - `workspace_id` string: Optional. Omit to use the connected account's own workspace; pass a workspace ID from whoami to require that specific workspace.

## Response `200`

Sync completed

- object
  - `success` boolean
  - `results` object

## Other responses

- `400`: Validation error
- `401`: Invalid or missing API key
- `403`: Request is authenticated but not allowed
- `404`: Resource not found
- `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)