Comment

Required product: Switch

Comments are related to contacts, and can be seen by everyone in the company.

  1. Properties
  2. Get all comments
  3. Create a comment
  4. Delete a comment

Comment properties

Name Description
id
{"id":1}
Comment ID.
contact_id
{"contact_id":2}
ID of Contact that the comment is about.
employee_id
{"employee_id":3}
ID of employee who created the comment.
body
{"body":"Will get back to us."}
The comment itself.
recipient_id
{"recipient_id":4}
(BETA) ID of Employee that will receive notification about this comment.

Get all comments

List all comments for a given contact in the authenticated company.

GET /api/v2/contacts/:contact_id/comments

Response

Status: 200 OK
{
  "comments": [
    {
      "id": 1,
      "contact_id": 2,
      "employee_id": 3,
      "recipient_id": 4,
      "body": "Will get back to us."
    }
  ]
}

Create a comment

Required product: Switch Plus

Create a comment on a contact in the authencitated company.

Properties

Name Description
employee_id
{"employee_id":3}
ID of employee who created the comment.
body
{"body":"Will get back to us."}
(OPTIONAL if recipient_id is present) The comment itself.
recipient_id
{"recipient_id":4}
(OPTIONAL if body is present) ID of Employee that will receive notification about this comment.

Request

POST /api/v2/contacts/:contact_id/comments
{
  "comment": {
    "employee_id": 3,
    "body": "Well get back to us.",
    "recipient_id": 4
  }
}

Response

Status: 200 OK
{
  "comment": {
    "id": 1,
    "contact_id": 2,
    "employee_id": 3,
    "recipient_id": 4,
    "body": "Will get back to us."
  }
}

Delete a comment

Required product: Switch Plus

Delete a comment.

Request

DELETE /api/v2/contacts/:contact_id/comments/:id

Response

Status: 200 OK