Properties

  • archived - (boolean)
  • body - (optional)
  • complete - (boolean, read-only) This signals when all data is in the package. A "sent" or "received" package is not considered "complete" if data is still in transit.
  • created_at - (read-only)
  • failed - (boolean, read-only) If a package is "sent" or "received", but there was an error before it could be marked "complete", failed will be true.
  • files - (included only for "files" messages) An array of File resources
    • id
    • name
    • node_id
  • id
  • package_id - (included only for "package" messages)
  • read - (boolean)
  • received - (boolean, read-only)
  • recipients - An array specifying to whom this Message will be (or was) sent. If sending to a dropbox, the dropbox must be the only recipient.
    • email - (from cache, only for type "user")
    • id - The ID of the User or Group. If type is "email", this has the email address.
    • name - (from cache)
    • type - "user", "group", "email", or "dropbox"
  • sender - a single object representing the sending user
    • email - (from cache)
    • id
    • name - (from cache)
    • type - "user", or "url_token" if the package/message was sent using an invitation via public link.
  • sent - (boolean, read-only, except when setting to true on a draft files message)
  • subject - (optional)
  • type

The message type determines its behavior as well as the email template that will be used to generate emails for recipients.

  • "package" - the message will get sent once the package gets marked as complete
  • "files" - the message will get sent right away on creation

Messages can be filtered based on status flags sent, received, archived, read, complete, and failed. Draft messages have sent and received both false.

  • archived - (boolean)
  • complete - (boolean)
  • failed - (boolean)
  • q - Search body and subject
  • read - (boolean)
  • received - (boolean)
  • sender_email
  • sender_id
  • sender_name
  • sent_at
  • sent - (boolean)
  • type
  • workspace_id

The message type determines its behavior as well as the email template that will be used to generate emails for recipients.

  • "file_shared" - the message is about Files and will have a files property.
  • "package_received" - the message is about a Package and will have a package_id property.

GET only

GET only

POST /api/v1/messages
{
  "recipients": [
    {"type": "user", "id": "3"},
    {"type": "email", "id": "amy@contractor.com"}
  ],
  "type": "package",
  "subject": "Vacation",
  "body": "Here are the videos I took on my vacation",
  "package_id": "1xaEzw"
}
201 Created
{
  "id":"97",
  "created_at":"2014-04-15T18:51:32.137Z",
  "sender":{
    "id":"2",
    "name":"Jacob Erlich",
    "email":"jacob@asperasoft.com"
  },
  "recipients": [{
    "type":"user",
    "id":"3",
    "name":"Jimmy Song",
    "email":"jimmy@asperasoft.com"
  }, {
    "type": "email",
    "id": "amy@contractor.com"
  }],
  "subject":"Vacation",
  "body":"Here are the videos I took on my vacation",
  "sent":false,
  "archived":false,
  "type":"package",
  "package_id": "1xaEzw"
}
GET /api/v1/messages
200 Ok
[{
  "id":"97",
  "created_at":"2014-04-15T18:51:32.137Z",
  "sender":{
    "id":"2",
    "name":"Jacob Erlich",
    "email":"jacob@example.com"
  },
  "recipients": [{
    "type":"user",
    "id":"3",
    "name":"Jimmy Song",
    "email":"jimmy@example.com"
  }, {
    "type": "email",
    "id": "amy@contractor.com"
  }],
  "subject":"Vacation",
  "body":"Here are the videos I took on my vacation",
  "sent":false,
  "archived":false,
  "type":"package_received",
  "package_id": "1xaEzw"
}]
Video player

Video

×

Reset your Password Password resets are handled on the Support Site

×