---
title: "Add a customer"
method: POST
path: "/api/v1/customers"
tags: ["Customers"]
---

# Add a customer

`POST /api/v1/customers`

Note: setting send_email to true will send an email to the customer prompting them to create a password

## Request body

- V1AddCustomer
  - `email_address` string, email, nullable
  - `first_name` string, required
  - `last_name` string, required
  - `order_count` integer
  - `loyalty_points` number, double
  - `created_date` string, date-time
  - `modified_date` string, date-time
  - `last_login_date` string, date-time
  - `last_login_attempt_date` string, date-time
  - `locked` boolean
  - `locked_date` string, date-time, nullable
  - `locked_end_date` string, date-time, nullable
  - `is_subscribed_to_newsletter` boolean
  - `send_email` boolean

## Response `200`

The added Customer

- TempestResponseV1Customer
  - `meta` object, nullable
  - `links` TempestLink[], nullable
    - `rel` string, nullable
    - `href` string, nullable
  - `validation_result` TempestValidationError[], nullable
    - `member_names` string[], nullable
    - `error_message` string, nullable
  - `errors` object, nullable
  - `data` V1Customer
    - `id` integer
    - `email_address` string, nullable
    - `first_name` string, required
    - `last_name` string, required
    - `order_count` integer
    - `loyalty_points` number, double
    - `created_date` string, date-time
    - `modified_date` string, date-time
    - `last_login_date` string, date-time
    - `last_login_attempt_date` string, date-time
    - `locked` boolean
    - `locked_date` string, date-time, nullable
    - `locked_end_date` string, date-time, nullable
    - `is_subscribed_to_newsletter` boolean
    - `addresses` V1CustomerAddress[], nullable
      - `id` integer
      - `created_date` string, date-time, nullable
      - `modified_date` string, date-time, nullable
      - `customer_id` integer
      - `is_preferred_billing_address` boolean
      - `is_preferred_shipping_address` boolean
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `company` string, nullable
      - `address` string, required
      - `address2` string, nullable
      - `town` string, required
      - `county` string, nullable
      - `country` string, required
      - `friendly_country` string, nullable
      - `post_code` string, required
      - `telephone` string, nullable
      - `fax` string, nullable

## Other responses

- `400` — Invalid Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.dev/ekm/apis/ekm-partner-api.md) · [All operations](https://skmtc.dev/ekm/apis/ekm-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ekm/ekm-partner-api/revisions/853bef073bb3/schema)