Skip to main content
POST
/
sync
/
businesses
/
{business_id}
/
customers
/
batch
Sync a batch of customers
curl --request POST \
  --url https://api.pocketflows.com/sync/businesses/{business_id}/customers/batch \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "phone_number": "<string>",
      "email_address": "<string>",
      "metadata": {},
      "full_name": "<string>"
    }
  ]
}
'
{
  "customers": [
    {
      "id": "<string>",
      "external_id": "<string>",
      "email_address": "<string>",
      "phone_number": "<string>",
      "full_name": "<string>",
      "metadata": {},
      "unsubscribed": "future"
    }
  ],
  "errors": [
    "<unknown>"
  ]
}
Creates the customer if it doesn’t exist or updates the customer that corresponds to the id or external_id that is provided. Partially succeeds when some but not all customers 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.

Path Parameters

​
business_id
string
required

The ID of the business

Body

application/json
​
customers
object[]
required

The customers to sync

Response

200 - application/json

The customers that were synced

​
customers
(The Customer object · object | null)[]
required

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

​
errors
any[]
required

The errors that occurred during the sync