Create a contact note - YCloud Docs

{
  "id": "6a3de646e18f344f743aaa4d",
  "contactId": 1693364594105000000,
  "content": "Customer prefers follow-up in the morning.",
  "operatorId": "user_123",
  "updateOperatorId": "user_123",
  "createTime": "2022-06-01T12:00:00.000Z",
  "updateTime": "2022-06-01T12:00:00.000Z"
}

{
  "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>"
    }
  }
}

{
  "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

/

{contactIdentifier}

/

notes

{
  "id": "6a3de646e18f344f743aaa4d",
  "contactId": 1693364594105000000,
  "content": "Customer prefers follow-up in the morning.",
  "operatorId": "user_123",
  "updateOperatorId": "user_123",
  "createTime": "2022-06-01T12:00:00.000Z",
  "updateTime": "2022-06-01T12:00:00.000Z"
}

{
  "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>"
    }
  }
}

{
  "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

Path Parameters

contactIdentifier

string

required

Identifier of the contact that owns the note. Supports a contact ID, a username without the leading @, or a phone number in E.164 format starting with +. Usernames contain 3 to 35 letters, digits, periods, or underscores. A numeric value is resolved as a username first and then as a contact ID when no matching username exists.

Maximum string length: 255

Example:

"alice_01"

Body

application/json

Request body for creating or updating one contact note.

content

string

required

Note content. Leading and trailing whitespace is removed before validation and storage.

Required string length: 1 - 500

Example:

"Customer now prefers afternoon follow-up."

Response

Successfully created the contact note.

Represents an internal note attached to a contact.

id

string

required

Unique 24-character ObjectId for the contact note. IDs remain unchanged after storage migration.

Required string length: 24

Pattern: ^[0-9a-fA-F]{24}$

Example:

"6a3de646e18f344f743aaa4d"

contactId

string

required

Unique ID of the contact that owns this note.

Example:

1693364594105000000

content

string

required

Note content.

Maximum string length: 500

Example:

"Customer prefers follow-up in the morning."

operatorId

string

ID of the actor who created the note.

Example:

"user_123"

updateOperatorId

string

ID of the actor who last updated the note.

Example:

"user_123"

createTime

string<date-time>

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

Example:

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

updateTime

string<date-time>

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

Example:

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