---
title: "Create or update customer"
method: POST
path: "/api/v1/customers"
tags: ["Customers"]
---

# Create or update customer

`POST /api/v1/customers`

## Request

- Base URL: `https://api.simplesat.io`
- URL: `https://api.simplesat.io/api/v1/customers`
- Auth: API key in header `X-Simplesat-Token`

Create or update a customer. 

If the customer with the specified email address already exists, the
existing customer will be updated.

Updating the `custom_attributes` or `tags` fields will overwrite any existing values.

Customers accept arrays in `custom_attributes`.

Required scopes: `write customers`

## Request body

- object
  - `external_id` string
  - `email` string
  - `name` string
  - `company` string
  - `language` string
  - `tags` string[]
  - `custom_attributes` object

## Response `201`

Successful response

- object
  - `id` integer
  - `external_id` string
  - `email` string
  - `name` string
  - `tags` string[]
  - `custom_attributes` object
  - `company` string
  - `language` string

---

[API](https://skmtc.dev/simplesat/apis/simplesat-api-v1.md) · [All operations](https://skmtc.dev/simplesat/apis/simplesat-api-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/simplesat/apis/simplesat-api-v1/revisions/1c245425416b?raw)