Add an internal note to a thread (ticket)

POST

/openapi/thread/note/{threadId}

curl --request POST \
  --url https://open-api.replyco.com/openapi/thread/note/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "note": "Customer called about this order. Refund approved." }'

• Production

Adds a note that only your team can see. It is never sent to the customer. The note’s author is the user making this request, and agents who have the ticket open see the note straight away.

Sample request:

POST /thread/note/3fa85f64-5717-4562-b3fc-2c963f66afa6
{
   "note": "Customer called about this order. Refund approved."
}

Authorizations

• Bearer

Parameters

Path Parameters

threadId

required

string format: uuid

Thread ID to add the note to

Request Body

Request containing the note

object

note

required

The note’s text. Can contain basic HTML, which is sanitized before saving.

string

>= 1 characters

Example

{
  "note": "Customer called about this order. Refund approved."
}

object

note

required

The note’s text. Can contain basic HTML, which is sanitized before saving.

string

>= 1 characters

Example ^generated

{
  "note": "example"
}

object

note

required

The note’s text. Can contain basic HTML, which is sanitized before saving.

string

>= 1 characters

Example ^generated

{
  "note": "example"
}

object

note

required

The note’s text. Can contain basic HTML, which is sanitized before saving.

string

>= 1 characters

Example ^generated

{
  "note": "example"
}

Responses

200

Note was created

400

The note is missing or empty. The response body carries the reason in its ‘error’ field

401

User is not authenticated or authorized

404

Thread with the specified ID was not found