RelayAPI

Add an internal note to a conversation

POST
/v1/inbox/conversations/{id}/notes
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_*)

In: header

Path Parameters

id*string

Conversation ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/inbox/conversations/string/notes" \  -H "Content-Type: application/json" \  -d '{    "text": "string",    "user_id": "string"  }'
{  "note": {    "id": "note_abc123",    "conversation_id": "string",    "organization_id": "string",    "user_id": "string",    "author_name": "string",    "author_email": "string",    "text": "string",    "created_at": "string",    "updated_at": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}

Found something wrong? Help us improve this page.

Submit an Issue
Requires a GitHub account.View repo