cURL
curl --request POST \ --url https://api.pocketflows.com/businesses/{id}/customers/batch \ --header 'Authorization: Basic <encoded-value>' \ --header 'Content-Type: application/json' \ --data ' { "customers": [ { "email_address": "<string>", "phone_number": "<string>", "metadata": {} } ] } '
{ "customers": [ { "id": "<string>", "external_id": "<string>", "email_address": "<string>", "phone_number": "<string>", "metadata": {}, "unsubscribed": "future" } ], "errors": [ { "message": "<string>", "path": "<string>" } ] }
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Basic <encoded-value>
<encoded-value>
username:password
The ID of the business
An array of customer data to create
Show child attributes
The email address of the customer
The phone number of the customer
Any metadata to attach to the customer
An array of created Customer objects
Customer
An array of created Customer objects (null for entries that failed)
The ID of the customer
The external ID of the customer
The metadata associated with this customer
The unsubscribe status of the customer
future
campaign
An array of errors
The error message
The path to the field that caused the error