---
title: "Sync a business"
method: POST
path: "/sync/businesses"
tags: ["Sync"]
---

# Sync a business

`POST /sync/businesses`

## Request body

- union
  - object
    - `id` string, required — The ID of the business
    - `external_id` string, nullable — The external ID of the business
    - `name` string, required — The name of the business
    - `metadata` object — The metadata of the business
  - object
    - `external_id` string, required — The external ID of the business
    - `name` string, required — The name of the business
    - `metadata` object — The metadata of the business

## Response `200`

The synced `Business` object

- Business
  - `id` string, required — The ID of the business
  - `external_id` string, nullable, required — The external ID of the business
  - `name` string, required — The name of the business
  - `metadata` object, required — Arbitrary metadata associated with this business
  - `created_at` string, required — The date and time the business was created
  - `website` string, nullable, required — The website URL of the business
  - `disabled_steps` string[], nullable, required — Steps disabled for this business. If `null`, the business inherits the project's `disabled_steps`. If set (including `[]`), this list fully overrides the project's setting.

---

[API](https://skmtc.dev/pocketflows/apis/pocketflows-api.md) · [All operations](https://skmtc.dev/pocketflows/apis/pocketflows-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pocketflows/pocketflows-api/revisions/26723490b96f/schema)