---
title: "Create a contact"
method: POST
path: "/v1/contacts"
tags: ["Contacts"]
---

# Create a contact

`POST /v1/contacts`

Create a new contact (required scope contacts:write)

## Headers

- `Customer-Id` integer, required

## Request body

- CreateContactModel — Create contact request model
  - `reference` string, nullable — The internal reference of the contact - should usually be unique
  - `name` string, required — The name of the contact
  - `groupId` integer, required — The unique identifier of the group this contact belongs to
  - `parentId` integer, nullable — The unique identifier of the parent contact of this contact
  - `extraInformation` string, nullable — A free text description about the contact
  - `street` string, nullable — The contact street address
  - `town` string, nullable — The contact address town / city / village / locality
  - `postalCode` string, nullable — The contact address postcode or zipcode
  - `country` string, nullable — The textual name of the contact address country
  - `location` Location, required — Represents a geographical location
    - `latitude` number, double, required — Latitude of the center of the location
    - `longitude` number, double, required — Longitude of the center of the location
  - `customFields` CustomFieldWriteModel[], nullable — Custom fields associated with the contact
    - `definitionId` integer, required — The unique identifier of the associated custom field definition
    - `value` string, nullable — The value of this custom field. If set to null, any existing value will be unset

## Response `201`

Created

- PostResponseInt64 — Represents a response for a POST request, containing the ID of the newly created record
  - `id` integer — Identifier of the newly created record

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)