Skip to main content

resources/events/message (post)

This method lets you post a message to a scope. The message is saved depending on the specific scope:

Scope

Action

Job

The message is saved to the job, just like messages posted from the job page or during status changes.

Project

The message is saved to the project, just like messages posted from the project details page or during status changes.

Any other scope

The request will be accepted but the message will be disregarded. We may change this behavior in the future.

URL

CODE
(POST) /api/resources/events/message

PARAMETERS

The request BODY contains a JSON object with these properties:

scope

The scope of segments. See Scope (Object).

object, Mandatory

message

The message to submit.

Note: The text will be cropped at 500 characters.

int, Mandatory

isError

Optional, default is false. Set to true if the message reports an error.

bool? Optional

RESULTS

The result is a JSON object with property “saved”:

  • saved: Boolean that indicates if the message was saved. It will be true for Job and Project scopes and false for any other scope.

Example:

JSON
{
    "saved": true
}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.