Create a contact - YCloud Docs

{
  "id": 1693364594105000000,
  "remarkName": "Priority customer",
  "nickname": "nickname",
  "metaUsername": "alice_01",
  "countryCode": "US",
  "countryName": "<string>",
  "phoneNumber": "+16315551111",
  "email": "support@example.com",
  "lastSeen": "2022-06-01T12:00:00.000Z",
  "lastMessageToPhoneNumber": "+16315551111",
  "tags": [
    "<string>"
  ],
  "createTime": "2022-06-01T12:00:00.000Z",
  "customAttributes": [
    {
      "name": "<string>",
      "value": {}
    }
  ],
  "ownerEmail": "support@example.com",
  "sourceType": "API",
  "sourceId": "batch_import_123",
  "sourceUrl": "https://example.com/signup"
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

POST

https://api.ycloud.com/v2

/

contact

/

contacts

{
  "id": 1693364594105000000,
  "remarkName": "Priority customer",
  "nickname": "nickname",
  "metaUsername": "alice_01",
  "countryCode": "US",
  "countryName": "<string>",
  "phoneNumber": "+16315551111",
  "email": "support@example.com",
  "lastSeen": "2022-06-01T12:00:00.000Z",
  "lastMessageToPhoneNumber": "+16315551111",
  "tags": [
    "<string>"
  ],
  "createTime": "2022-06-01T12:00:00.000Z",
  "customAttributes": [
    {
      "name": "<string>",
      "value": {}
    }
  ],
  "ownerEmail": "support@example.com",
  "sourceType": "API",
  "sourceId": "batch_import_123",
  "sourceUrl": "https://example.com/signup"
}

{
  "error": {
    "status": 404,
    "code": "NOT_FOUND",
    "message": "The requested resource does not exist.",
    "target": "",
    "docUrl": "",
    "requestId": "req_1KjtKI80IKoaJNa6n6p",
    "whatsappApiError": {
      "message": "HSM Template creation failed",
      "code": 200002,
      "type": "OAuthException",
      "is_transient": false,
      "error_subcode": 2388109,
      "error_user_msg": "This message template cannot be created.",
      "error_user_title": "Message Cannot Be Submitted",
      "fbtrace_id": "AVGjJ7ia2zJkrHG",
      "error_data": "<string>"
    },
    "metaBusinessAgentApiError": {
      "title": "<string>",
      "detail": "<string>",
      "type": "<string>",
      "status": 123,
      "requestId": "<string>"
    }
  }
}

Authorizations

X-API-Key

string

header

required

Body

application/json

Contains the properties of the contact to be created.

phoneNumber

string

required

Unique Phone number in E.164 format.

Example:

"+16315551111"

remarkName

string

Contact's remark name. Maximum length: 250 characters.

Maximum string length: 250

Example:

"remark name"

nickname

string

deprecated

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.

Maximum string length: 250

Example:

"remark name"

countryCode

string

Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.

Example:

"US"

email

string

Contact's email address. If present, the email address must be unique.

Maximum string length: 250

Example:

"support@example.com"

tags

string[]

Contact's tags. Max items: 50. Max characters per tag: 50.

Maximum array length: 50

Tag. Maximum length: 50 characters.

Maximum string length: 50

customAttributes

object[]

Contact's custom attributes.

Show child attributes

ownerEmail

string

The email address of the contact's owner.

Maximum string length: 250

Example:

"support@example.com"

notes

object[]

Optional notes created atomically with the contact. The response remains the Contact schema; use the List Contact Notes endpoint to retrieve generated note IDs.

Maximum array length: 50

Show child attributes

Response

Successfully created a contact.

Represents a contact.

id

string

required

Unique ID for the object.

Maximum string length: 255

Example:

1693364594105000000

remarkName

string

The business-managed remark name for the contact.

Maximum string length: 250

Example:

"Priority customer"

nickname

string

The read-only nickname obtained from WhatsApp.

Example:

"nickname"

metaUsername

string

The read-only Meta username associated with the contact, without the leading @.

Example:

"alice_01"

countryCode

string

Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.

Example:

"US"

countryName

string

Full country name.

phoneNumber

string

Unique Phone number in E.164 format.

Example:

"+16315551111"

email

string

The contact's email address. If present, the email address must be unique.

Example:

"support@example.com"

lastSeen

string<date-time>

The time at which the contact last sent a message to your business, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example:

"2022-06-01T12:00:00.000Z"

lastMessageToPhoneNumber

string

The business phone number that the contact last sent a message to.

Example:

"+16315551111"

tags

string[]

Contact's tags.

Maximum array length: 50

Maximum string length: 50

createTime

string<date-time>

The time at which the contact was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example:

"2022-06-01T12:00:00.000Z"

customAttributes

object[]

Contact's custom attributes.

Show child attributes

ownerEmail

string

The email address of the contact's owner.

Maximum string length: 250

Example:

"support@example.com"

sourceType

enum<string>

The source type of the contact. Indicates how the contact was created.

Available options:

WHATSAPP,

GROWTH_TOOL,

MANUALLY_ADDED,

FILE_IMPORT,

SHOPIFY,

API,

AD,

POST,

CALLING,

SMB,

UNKNOWN

Example:

"API"

sourceId

string

Source identifier. A unique identifier related to the contact creation source.

Maximum string length: 255

Example:

"batch_import_123"

sourceUrl

string

Source URL. The source link address where the contact was created.

Maximum string length: 500

Example:

"https://example.com/signup"