Skip to main content
POST
/
sync
/
businesses
/
batch
Sync a batch of businesses
curl --request POST \
  --url https://api.pocketflows.com/sync/businesses/batch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businesses": [
    {
      "id": "<string>",
      "name": "<string>",
      "external_id": "<string>",
      "metadata": {}
    }
  ]
}
'
{
  "businesses": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "name": "<string>",
      "metadata": {},
      "created_at": "<string>",
      "website": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.pocketflows.com/llms.txt

Use this file to discover all available pages before exploring further.

Creates the business if it doesn’t exist or updates the business that corresponds to the id or external_id that is provided. Partially succeeds when some but not all businesses have valid information

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
​
businesses
object[]
required

The businesses to sync

Response

200 - application/json

The synced Business objects

​
businesses
(The Business object · object | null)[]
required

The businesses that were synced. Will be null for businesses that had errors