Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Notify people of a commentWeb URL to open the translation editor in a browser.

URL

(POSTGET) /resources/comments/{cmid}/notifyeditor/go

PARAMETERS

The URL parameters are:

cmidThe ID of the comment to notify.Mandatory

 

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

scopeThe 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 Block
[ { "cid": 133, "pid": null }, { "cid": 200, "pid": 23 } ]
Mandatory
messageOptional 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

...

s

Must be the key of a scope, such as:

  • p300: To view project with ID 300
  • jc100: To view Codyt job with ID 100
  • ...

See scope object for details.

Mandatory
didOptional ID of the document to preselect.Optional
sidOptional ID of the segment to preselect in the editor.Optional

 

EXAMPLES

Open a project and preselect a specific document:

{wordbee server}/editor/go?s=p9983&did=223