Conversations

Also see Conversations.

Users

Also see Users.

Resource representations

{
  "kind": "receipt",
  "id": integer,
  "receiver": user,
  "is_read": boolean,
  "trashed": boolean,
  "deleted": boolean,
  "mailbox_type": string,
  "created_at": datetime,
  "updated_at": datetime,
  "message": {
    "kind": "message",
    "id": integer,
    "body": string,
    "subject": string,
    "sender": user,
    "created_at": datetime,
    "updated_at": datetime
  }
}

Methods


Create a new message and its receipt.

Params

Param Name Description
conversation_id
Required

The id of the conversation to add the message to.


Value:

Must be a number.

receipt
Required

Receipt data.


Value:

Must be a Hash

receipt[body]
Required

The body of the message.


Value:

Must be String

receipt[subject]
Optional

The subject of the message.


Value:

Must be String


List all the receipts in the specified conversation.

Params

Param Name Description
box
Optional

Which box to list the receipts from. Optional. The default is “not_trash”.

Acceptable values are:

  • inbox
  • sentbox
  • trash
  • not_trash
  • all

Value:

Must be one of: inbox, sentbox, trash, not_trash, all.


Mark a receipt as read.

Params

Param Name Description
id
Required

The id of the receipt to delete.


Value:

Must be a number.


Delete a message and its receipt.

Params

Param Name Description
id
Required

The id of the receipt to delete.


Value:

Must be a number.