Batch Customers

Batch create, update, and delete customers

POST/customers/batch

Use it in a workflow

Add a step and choose the WooCommerce connector.
Pick the Batch Customers action (under Customers).
Fill in the fields below, then reference the result from later steps as {{batchCustomers.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

createarray<object>

idinteger

Unique identifier for the resource. read-only

date_createdstring (date-time)

The date the customer was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the customer was created, as GMT. read-only

date_modifiedstring (date-time)

The date the customer was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the customer was last modified, as GMT. read-only

emailstring

The email address for the customer. mandatory

first_namestring

Customer first name.

last_namestring

Customer last name.

rolestring

Customer role. read-only

usernamestring

Customer login name.

passwordstring

Customer password. write-only

billingobject11 fields

shippingobject10 fields

is_paying_customerboolean

Is the customer a paying customer? read-only

avatar_urlstring

Avatar URL. read-only

meta_dataarray<object>5 fields

Meta data.

updatearray<object>

idinteger

Unique identifier for the resource. read-only

date_createdstring (date-time)

The date the customer was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the customer was created, as GMT. read-only

date_modifiedstring (date-time)

The date the customer was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the customer was last modified, as GMT. read-only

emailstring

The email address for the customer. mandatory

first_namestring

Customer first name.

last_namestring

Customer last name.

rolestring

Customer role. read-only

usernamestring

Customer login name.

passwordstring

Customer password. write-only

billingobject11 fields

shippingobject10 fields

is_paying_customerboolean

Is the customer a paying customer? read-only

avatar_urlstring

Avatar URL. read-only

meta_dataarray<object>5 fields

Meta data.

deletearray<integer>

json

{
  "create": [
    {
      "id": 0,
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "string",
      "username": "string",
      "password": "string",
      "billing": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "country": "string",
        "email": "string",
        "phone": "string"
      }
    }
  ],
  "update": [
    {
      "id": 0,
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "string",
      "username": "string",
      "password": "string",
      "billing": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "country": "string",
        "email": "string",
        "phone": "string"
      }
    }
  ],
  "delete": [
    0
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{batchCustomers.response.data.<field>}}.

createarray<object>

idinteger

Unique identifier for the resource. read-only

date_createdstring (date-time)

The date the customer was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the customer was created, as GMT. read-only

date_modifiedstring (date-time)

The date the customer was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the customer was last modified, as GMT. read-only

emailstring

The email address for the customer. mandatory

first_namestring

Customer first name.

last_namestring

Customer last name.

rolestring

Customer role. read-only

usernamestring

Customer login name.

passwordstring

Customer password. write-only

billingobject11 fields

shippingobject10 fields

is_paying_customerboolean

Is the customer a paying customer? read-only

avatar_urlstring

Avatar URL. read-only

meta_dataarray<object>5 fields

Meta data.

updatearray<object>

idinteger

Unique identifier for the resource. read-only

date_createdstring (date-time)

The date the customer was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the customer was created, as GMT. read-only

date_modifiedstring (date-time)

The date the customer was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the customer was last modified, as GMT. read-only

emailstring

The email address for the customer. mandatory

first_namestring

Customer first name.

last_namestring

Customer last name.

rolestring

Customer role. read-only

usernamestring

Customer login name.

passwordstring

Customer password. write-only

billingobject11 fields

shippingobject10 fields

is_paying_customerboolean

Is the customer a paying customer? read-only

avatar_urlstring

Avatar URL. read-only

meta_dataarray<object>5 fields

Meta data.

deletearray<object>

idinteger

Unique identifier for the resource. read-only

date_createdstring (date-time)

The date the customer was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the customer was created, as GMT. read-only

date_modifiedstring (date-time)

The date the customer was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the customer was last modified, as GMT. read-only

emailstring

The email address for the customer. mandatory

first_namestring

Customer first name.

last_namestring

Customer last name.

rolestring

Customer role. read-only

usernamestring

Customer login name.

passwordstring

Customer password. write-only

billingobject11 fields

shippingobject10 fields

is_paying_customerboolean

Is the customer a paying customer? read-only

avatar_urlstring

Avatar URL. read-only

meta_dataarray<object>5 fields

Meta data.

json

{
  "create": [
    {
      "id": 0,
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "string",
      "username": "string",
      "password": "string",
      "billing": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "country": "string",
        "email": "string",
        "phone": "string"
      }
    }
  ],
  "update": [
    {
      "id": 0,
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "string",
      "username": "string",
      "password": "string",
      "billing": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "country": "string",
        "email": "string",
        "phone": "string"
      }
    }
  ],
  "delete": [
    {
      "id": 0,
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z",
      "date_modified_gmt": "2025-01-01T00:00:00Z",
      "email": "string",
      "first_name": "string",
      "last_name": "string",
      "role": "string",
      "username": "string",
      "password": "string",
      "billing": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "state": "string",
        "postcode": "string",
        "country": "string",
        "email": "string",
        "phone": "string"
      }
    }
  ]
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.

Was this page helpful?