Skip to main content
POST
/
v1
/
customers
/
bulk
/
async
Update Customers in Bulk
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/customers/bulk/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '[
  {
    "source_id": "John.Smith@email.com",
    "name": "John Smith",
    "email": "john.smith@email.com",
    "description": "Updating customer data",
    "phone": "+1 (132) 222-2222",
    "address": {
      "city": "New York",
      "country": "United States",
      "line_1": "123 Main St.",
      "line_2": "APT 3 BLG 4",
      "postal_code": "10001",
      "state": "NY"
    },
    "metadata": {
      "lang": "en",
      "test": true
    },
    "birthday": "2022-04-04"
  },
  {
    "source_id": "Jane.Smith@email.com",
    "name": "Jane Smith",
    "email": "Jane.Smith@email.com",
    "description": "Updating customer data",
    "phone": "+1 (132) 222-2222",
    "address": {
      "city": "New York",
      "country": "United States",
      "line_1": "123 Main St.",
      "line_2": "APT 3 BLG 4",
      "postal_code": "10001",
      "state": "NY"
    },
    "metadata": {
      "lang": "en",
      "test": true
    },
    "birthday": "2022-03-03"
  },
  {
    "source_id": "Sally.Smith@email.com",
    "name": "Sally Smith",
    "email": "Sally.Smith@email.com",
    "description": "Updating customer data",
    "phone": "+1 (132) 222-2222",
    "address": {
      "city": "New York",
      "country": "United States",
      "line_1": "123 Main St.",
      "line_2": "APT 3 BLG 4",
      "postal_code": "10001",
      "state": "NY"
    },
    "metadata": {
      "lang": "en",
      "test": true
    },
    "birthdate": "2022-02-02"
  }
]'
{
  "async_action_id": "aa_0a875d56c805df6601"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json · CustomerSourceId · object[]

List the customer fields to be updated in each customer object.

Request body schema for /customers/bulk/async.

​
source_id
string
required

Unique customer source ID.

​
name
string

Customer's first and last name.

​
description
string

An arbitrary string that you can attach to a customer object.

​
email
string

Customer's email address.

​
phone
string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

​
birthday
string<date>

Deprecated. Customer's birthdate; format YYYY-MM-DD.

​
birthdate
string<date>

Customer's birthdate; format YYYY-MM-DD.

​
address
object | null

Customer's address.

​
metadata
object

A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

Response

Returns the ID of the scheduled asynchronous action. The response informs you that the request has been accepted and the resources will be updated in the repository asynchronously. To check the status and result, copy the async_action_id from the response and use it as a query parameter in the GET Async Action endpoint.

Response body schema for POST v1/customers/bulk/async. Response to requests that are processed asynchronously.

​
async_action_id
string
required

The ID of the scheduled asynchronous action.

Example:

"aa_0a875d56c805df6601"

⌘I