Comments

Create comment

Add a comment to a campaign lead.

Parameters. Send the following in the request body. All three are required:

  • creator_user_id (string): The ID of the user creating the comment. This user must already exist.
  • campaign_lead_id (string): The ID of the campaign lead the comment belongs to. This campaign lead must already exist.
  • body (string): The comment text. It cannot be empty.

Returns. { "comments": [ { ... } ] } containing the created comment with its id, created_at timestamp, and success set to true.

Example.

{
  "creator_user_id": "100",
  "campaign_lead_id": "1234",
  "body": "this is your comment content"
}
post/{sub_domain}/api/comments

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/comments
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

creator_user_idstring required

ID of the user creating the comment.

campaign_lead_idstring required

ID of the campaign lead the comment relates to.

bodystring required

The comment's text.

Response

Successful Response

total_commentsinteger nullable

Total number of comments in the response.

Example response

{
  "comments": [
    {
      "body": "I should be the one to call back to this customer",
      "campaign_lead_id": 257456,
      "created_at": "2016-12-07 11:15:02",
      "creator_user_id": 126,
      "id": 33923,
      "lead_id": 171287,
      "original_identifier": "500040",
      "username": "demo"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.