GET /api/messages/

Description

Returns list of messages for person.

Parameters

start

DEPRECATED. Will be removed in future version. Use offset in stead.

limit

Int. Optional. Default: 20. Maximum: 100. Limit the size of the result set.

offset

Int. Optional. Default: 0. Offset the result set, starting at this index. For batching/paging.

user_name

String. Optional. Username identifying the person whose messages we want. If not given, will return messages for logged in person.

fields

String. Optional. See Field customization.

Return

Array of Message objects.

Security

Superuser, person’s manager and self

GET /api/messages/[message_id]

Description

Returns details for message.

Parameters

fields

String. Optional. See Field customization.

Return

Array of one Message object.

Security

Superuser, person’s manager and self

POST /api/messages

Description

Sends a message to user.

Parameters

user_name

String. Username identifying the person to send to.

title

String. Title or subject for message.

text

String. The message.

cc

String. Optional. Addresses to CC to. Separated by comma, semicolon or space

send_medium

String. Optional. ”sms”/”email”/”both”. How to send the message.

reply_to

String. Optional. None/”manager”/email address. What reply-to address to use. None will yield system’s default.

fields

String. Optional. See Field customization.

Return

Array of one Message object.

Security

Superuser, person’s manager and self