resources/comments/{cmid}/notify

Notify people of a comment.

URL

(POST) /resources/comments/{cmid}/notify

PARAMETERS

The URL parameters are:

cmid

The ID of the comment to notify.

Mandatory

The parameters are a JSON object included in the request body:

scope The scope object. The segment must be within the scope. Mandatory

to

An array of companies/persons to notify. Each array element has these properties:

cid: The company to notify
uid: The person to notify (optional)

You can only notify people who correspond to those returned by a prior call to resources/team/comment or resources/team/document

Example:

CODE

[ { "cid": 133, "pid": null }, { "cid": 200, "pid": 23 } ]

Mandatory

message Optional message to include. You do not really need to add a message because the email will already include the content of the comment. Optional

RESULTS

A JSON with these properties:

count

Total companies/people notified by email.

This generally is identical to the number of elements in the "to" parameter. However, the system eliminates targets that are not valid team members as well as those that have no email configured.

int