# Trigger a manual sync for a listing.

`POST /listings/{listing_id}/sync`

> Wheelhouse Revenue Management API. Web version: https://docs.usewheelhouse.com/rm/reference/rm-post-listing-sync · OpenAPI spec: https://docs.usewheelhouse.com/rm/openapi.yaml · Operation ID: `rmPostListingSync` · Tag: Listings

Enqueues a price-posting job that pushes the latest Wheelhouse price recommendations to
the connected channel and refreshes reservation data. Equivalent to clicking the **Sync**
button in the Wheelhouse UI.

**Plan requirement:** Manual syncs are only available on paid (Pro) plans. Listings on
free or onboarding plans will receive `429 Too Many Requests`.

**Rate limit:** The number of syncs allowed per day is determined by the listing's pricing
plan. Returns `429 Too Many Requests` when the daily limit is exceeded.

**Debounce:** To prevent duplicate jobs from stacking up, if another sync for the same
listing was requested within the last 60 seconds, the endpoint returns `423 Locked`.
Wait at least 60 seconds before retrying.

**Paused channels:** While syncing with the listing's channel is paused, for example during
the channel's scheduled maintenance, the endpoint returns `503 Service Unavailable` with a
`Retry-After` header. A refused sync does not count toward the daily limit.

The request returns `202 Accepted` immediately — the sync runs asynchronously in the
background. Use `GET /listings/{listing_id}/pricing_tier` or poll the Wheelhouse
dashboard to confirm when the sync has completed.

## Request

`POST https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/sync`

Authentication: send your RM API key in the `X-Integration-Api-Key` header (see https://docs.usewheelhouse.com/rm/authentication.md). Modifies data; read-only keys get `403 Forbidden`.

### Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `listing_id` | string | yes | The channel's unique listing identifier, or the Wheelhouse listing ID when `channel` is `wheelhouse`. |

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `channel` | string | yes | Channel name the listing is on (the `channel` field of the [/listings](https://docs.usewheelhouse.com/rm/reference/rm-get-listings.md) response), or the literal `wheelhouse` to read `listing_id` as a Wheelhouse listing ID instead. See [Identifying Listings](https://docs.usewheelhouse.com/rm/concepts/listings.md). |

### Example request

```bash
curl -X POST 'https://api.usewheelhouse.com/ss_api/v1/listings/{listing_id}/sync?channel=<channel>' \
  -H 'X-Integration-Api-Key: <your RM API key>'
```

Only required parameters and body fields are filled in, with placeholder values. Add the optional ones you need from the lists above; some are required in combination, as their descriptions say.

## Responses

### 202

Sync accepted and queued. The body is an empty object.

Body (`application/json`): object

Example shape (generated from the schema; placeholder values, not a real response):

```json
{}
```

### 401

API key authorization failed.

### 403

Listing authorization failed (listing does not belong to the authenticated user, or the API key is read-only).

### 404

Listing not found.

### 406

The listing is inactive. See the **Inactive Listings** section in the overview.

Body (`application/json`): object

- `error` (string, example: `Listing '12345' is inactive`)

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "Listing '12345' is inactive"
}
```

### 423

A sync was already requested for this listing within the last 60 seconds. Retry after the debounce window has elapsed.

### 429

Daily sync limit reached for this listing, or the listing plan does not include manual syncs.

### 503

Syncing with the listing's channel is paused. Retry after the number of seconds in the `Retry-After` header.

Body (`application/json`): object

- `error` (string, example: `channel_paused`)
- `channel` (string): The paused channel's short ID.
- `channel_name` (string)
- `message` (string): A message to show the user.
- `resumes_at` (string (date-time), nullable): When the pause is scheduled to end, or null if it has no scheduled end.

Example shape (generated from the schema; placeholder values, not a real response):

```json
{
  "error": "channel_paused",
  "channel": "string",
  "channel_name": "string",
  "message": "string",
  "resumes_at": "2026-01-01T00:00:00Z"
}
```
