POST
/
sync
/
businesses
curl --request POST \
  --url https://api.pocketflows.com/sync/businesses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "external_id": "<string>",
  "name": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "external_id": "<string>",
  "name": "<string>",
  "metadata": "<any>"
}

Creates the business if it doesn’t exist or updates the business that corresponds to the id or external_id that is provided

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
id
string
required

The ID of the business

​
name
string
required

The name of the business

​
external_id
string | null

The external ID of the business

​
metadata
object

The metadata of the business

Response

200 - application/json
The synced `Business` object
​
id
string
required

The ID of the business

​
external_id
string | null
required

The external ID of the business

​
name
string
required

The name of the business

​
metadata
any
required

Arbitrary metadata associated with this business