Create a note for a customer

Notes are related to interactions and insights about a customer. They can be useful for tracking the sales process and improving customer relationships.

post

Creates a note for a customer.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

Body

application/json

taskIdstringOptional

The ID of the task associated with the note.

opportunityIdstringOptional

The ID of the opportunity associated with the note.

textstringRequired

The text of the note.

Responses

200

Successful Response

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/v1/agents/{agentId}/customers/{customerId}/note

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/customers/{customerId}/note HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "taskId": "text",
  "opportunityId": "text",
  "text": "text"
}

{
  "code": "CUSTOMER_NOTE_CREATED",
  "message": "The customer note was created successfully."
}