---
title: "Pull live businesses + programs from the Yelp Partner API"
method: POST
path: "/app/yelp/sync"
tags: ["App Yelp"]
---

# Pull live businesses + programs from the Yelp Partner API

`POST /app/yelp/sync`

## Request

- Base URL: `https://api.optimyzee.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.optimyzee.com/app/yelp/sync`
- Auth: none declared
- TypeScript: <https://skmtc.dev/optimyzee/apis/optimyzee-api/docs/app/yelp/sync/post.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

OK

- AppYelpSyncRunSchema
  - `id` integer, required
  - `type` string, required
  - `source` string, required
  - `status` string, required
  - `startedAt` string, nullable, required
  - `finishedAt` string, nullable, required
  - `importedCount` integer, required
  - `failedCount` integer, required
  - `errorMessage` string, nullable, required
  - `createdAt` string, nullable, required

---

[API](https://skmtc.dev/optimyzee/apis/optimyzee-api.md) - [All operations](https://skmtc.dev/optimyzee/apis/optimyzee-api/llms.txt) - [OpenAPI document](https://skmtc.dev/optimyzee/apis/optimyzee-api/revisions/ccaa14692e9f?raw)
