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

# Create a contact

`POST /contact/contacts`

Creates a contact.

## Request body

- ContactCreateRequest — Contains the properties of the contact to be created.
  - `remarkName` string — Contact's remark name. Maximum length: 250 characters.
  - `nickname` string — Deprecated compatibility alias for `remarkName`. When `remarkName` is absent, this value is saved as the contact's remark name. It does not update the read-only WhatsApp nickname. Maximum length: 250 characters.
  - `phoneNumber` string, required — Unique Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  - `countryCode` string — Two-letter country abbreviation. See [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `email` string — Contact's email address. If present, the email address must be unique.
  - `tags` string[] — Contact's tags. Max items: 50. Max characters per tag: 50.
  - `customAttributes` ContactCustomAttribute[] — Contact's custom attributes.
    - `name` string — Name of the attribute that you've previously defined.
    - `value` object — Value of the attribute. Its data type depends on the format of the attribute you defined: For Text, the `value` is a string with a maximum length of 250. For Array, the `value` is an array of strings with a maximum length of 250. For Number, the `value` is a signed decimal number. For Boolean, the `value` is either `true` or `false`. For Time, the `value` is a Unix timestamp in milliseconds. For Long Text, the `value` is a string with a maximum length of 5000.
  - `ownerEmail` string — The email address of the contact's owner.

## Response `200`

Successfully created a contact.

- Contact — Represents a contact.
  - `id` string, required — Unique ID for the object.
  - `nickname` string — Contact's nickname.
  - `countryCode` string — Two-letter country abbreviation. See [ISO 3166-1 alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `countryName` string — Full country name.
  - `phoneNumber` string — Unique Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  - `email` string — The contact's email address. If present, the email address must be unique.
  - `lastSeen` string, date-time — The time at which the contact last sent a message to your business, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.
  - `lastMessageToPhoneNumber` string — The business phone number that the contact last sent a message to.
  - `tags` string[] — Contact's tags.
  - `createTime` string, date-time — The time at which the contact was created, formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). e.g., `2022-06-01T12:00:00.000Z`.
  - `customAttributes` ContactCustomAttribute[] — Contact's custom attributes.
    - `name` string — Name of the attribute that you've previously defined.
    - `value` object — Value of the attribute. Its data type depends on the format of the attribute you defined: For Text, the `value` is a string with a maximum length of 250. For Array, the `value` is an array of strings with a maximum length of 250. For Number, the `value` is a signed decimal number. For Boolean, the `value` is either `true` or `false`. For Time, the `value` is a Unix timestamp in milliseconds. For Long Text, the `value` is a string with a maximum length of 5000.
  - `ownerEmail` string — The email address of the contact's owner.
  - `sourceType` 'WHATSAPP' | 'GROWTH_TOOL' | 'MANUALLY_ADDED' | 'FILE_IMPORT' | 'SHOPIFY' | 'API' | 'AD' | 'POST' | 'CALLING' | 'SMB' | 'UNKNOWN' — Contact source type enumeration values. These are internal type identifiers, not the display names shown on the contact page. Each enumeration value corresponds to the following display names: - WHATSAPP: "Inbound message" - GROWTH_TOOL: "Link/QR Code" - MANUALLY_ADDED: "Manually added" - FILE_IMPORT: "File import" - SHOPIFY: "Shopify" - API: "API added" - AD: "AD" - POST: "Post" - CALLING: "Calling" - SMB: "Whatsapp Business App" - UNKNOWN: "Unknown"
  - `sourceId` string — Source identifier. A unique identifier related to the contact creation source.
  - `sourceUrl` string — Source URL. The source link address where the contact was created.

---

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