---
title: "Create Client"
method: POST
path: "/v1/clients"
---

# Create Client

`POST /v1/clients`

This API endpoint creates a client.

## Query parameters

- `sendInvite` boolean

## Request body

- object
  - `givenName` string, required — The client's given name (first name)
  - `familyName` string, required — The client's family name (last name)
  - `email` string, required — The client's email
  - `companyId` string — The ID of the company this client belongs to. When no ID is provided, a placeholder company will be created and returned in the response object
  - `customFields` string, json — The keys are the `key` of the custom field property, and the values are an array of custom field option `key`s (in the case of multiSelect custom fields), or the direct value in the case of all other types of custom fields.

## Response `200`

200

- object
  - `id` string
  - `object` string
  - `createdAt` string
  - `givenName` string
  - `familyName` string
  - `email` string
  - `companyId` string
  - `companyIds` string[]
  - `status` string
  - `fallbackColor` string
  - `inviteUrl` string
  - `avatarImageUrl` string
  - `firstLoginDate` string
  - `lastLoginDate` string
  - `customFields` object
    - `phoneNumber` string
    - `tags` string[]
    - `address` object
      - `country` string
      - `region` string
      - `postalCode` string
      - `addressLine1` string
      - `addressLine2` string
      - `city` string
      - `fullAddress` string
    - `email` string
    - `url` string
    - `number` number
  - `creationMethod` string
  - `updatedAt` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/assembly/apis/core-resources.md) · [All operations](https://skmtc.net/assembly/apis/core-resources/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/assembly/core-resources/versions/28a9e7d13a8c/schema)