messages/create

Description

This operation creates a message on a project or a todo.

URI

POST creates the message
http://ws.planzone.com/v1/rest/messages/create

Requires Authentication (about authentication):

yes

Requires Authorization (about authorization):

The application must have the 'write' permission granted from the Planzone.

The user must have access to the project, that is he must be a team member and be allowed to post a message on the project.

API rate limited (about rate limiting):

yes

Parameters

NameOptionalDescription
entityNOThe entity onto which the message is posted. The entity can be a project or a todo. The entity must exist and the associated project must not be closed.
messageNOThe message content. The message must not be empty.
recipientsYESThe list of user GUID to which the message must be sent by email.

The possible list of recipients can be obtained by using the users operation.

Request Example

The following request:

POST /v1/rest/messages/create entity=Bcd234hj&message=Write the report&recipients=me,Ecded

creates a message attached to the entity Bcd234hj and sends the message to two recipients.

Response

The response contains a Location header that gives the URL to get the todo information.

HTTP Status Codes

201 CREATED The message has been created
403 FORBIDDEN The message cannot be created (user is not member of the project or is not allowed to create todos on the project).
404 NOT FOUND The entity cannot be found

References

Planzone API

See also

projects
users
todos
message XML element