Skip to main content
POST
/
businesses
/
{id}
/
customers
/
batch_update
Update multiple customers
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id}/customers/batch_update \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customers": [
    {
      "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"
    }
  ]
}
Batch update is done as “all or nothing.” If any of the updates causes an error (say after updating two customers would have had the same email address), all updates in the batch are cancelled.

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

​
id
string
required

The ID of the business

Body

application/json
​
customers
object[]
required

An array of customer data to update. Must identify every customer with their ID

Response

200 - application/json

An array of updated Customer objects

​
customers
The Customer object · object[]
required

An array of updated Customer objects