Create a contact note

Add a new note to a contact. Mentions using the @USxxx / @GRxxx / @ORxxx tag syntax in the note text are automatically detected and resolved.

POST /contacts/{contactId}/notes

Create a contact note

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/contacts/{contactId}/notes \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "text": "@USabc321 can you follow up on this please?"
}
'

200

{
  "data": {
    "id": "6a145ff26212a192852c856f",
    "text": "Please follow up with the customer.",
    "media": [
      {
        "url": "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png",
        "type": "image/png",
        "name": "an_image.png"
      }
    ],
    "createdAt": "2021-01-01T00:00:00Z",
    "updatedAt": "2021-01-01T00:00:00Z",
    "actorId": "US123abc"
  }
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Path Parameters

contactId · string · required

The unique identifier of the contact whose notes are being listed.

Pattern: ^(.*)$

Example:

"6a145ff26212a192852c856e"

Body

application/json

text · string · required

The body of the note. Mentions using the @USxxx / @GRxxx / @ORxxx tag syntax are automatically detected and resolved.

Required string length: 1 - 2000

Example:

"@USabc321 can you follow up on this please?"

Response

200

application/json

OK

data · object · required

Show child attributes