messages

ViewSet for Message model.

get/api/v1.0/messages/

Response

idstring uuid required

primary key for the record as UUID

parent_idstring uuid nullable required
thread_idstring uuid nullable required
subjectstring nullable required
created_atstring date-time required

date and time at which a record was created

updated_atstring date-time required

date and time at which a record was last updated

draftBodystring nullable required
sent_atstring date-time nullable required
is_senderboolean required
is_draftboolean required
is_unreadboolean required
is_trashedboolean required
is_archivedboolean required
has_attachmentsboolean required
mime_idstring nullable required
stmsg_headersobject required

Return the STMSG headers of the message.

snippetstring required

Changes

Changed in 16 of the 54 revisions of this API.17625

    • the items/bcc/items/contact/allOf[Contact]/email response's property type/format changed from string/email to string/ for status 200

      response-property-type-changed

    • the items/cc/items/contact/allOf[Contact]/email response's property type/format changed from string/email to string/ for status 200

      response-property-type-changed

    • the items/sender/allOf[Contact]/email response's property type/format changed from string/email to string/ for status 200

      response-property-type-changed

    • the items/to/items/contact/allOf[Contact]/email response's property type/format changed from string/email to string/ for status 200

      response-property-type-changed

    • added the required property items/snippet to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the required property items/mime_id to the response with the 200 status

      response-required-property-added

  • 00a56b21a28b13See the full diff
    • added the new autoreply enum value to the items/signature/allOf[ReadMessageTemplate]/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property items/signature/allOf[ReadMessageTemplate]/metadata to the response with the 200 status

      response-optional-property-added

    • added the required property items/signature/allOf[ReadMessageTemplate]/is_active_autoreply to the response with the 200 status

      response-required-property-added

    • added the required property items/signature/allOf[ReadMessageTemplate]/signature to the response with the 200 status

      response-required-property-added

  • a5dc72b4835b211See the full diff
    • removed the required property items/signature/allOf[ReadMessageTemplate]/is_active_autoreply from the response with the 200 status

      response-required-property-removed

    • removed the required property items/signature/allOf[ReadMessageTemplate]/signature from the response with the 200 status

      response-required-property-removed

    • removed the optional property items/signature/allOf[ReadMessageTemplate]/metadata from the response with the 200 status

      response-optional-property-removed

    • removed the autoreply enum value from the items/signature/allOf[ReadMessageTemplate]/type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new autoreply enum value to the items/signature/allOf[ReadMessageTemplate]/type response property for the response status 200

      response-property-enum-value-added

    • added the optional property items/signature/allOf[ReadMessageTemplate]/metadata to the response with the 200 status

      response-optional-property-added

    • added the required property items/signature/allOf[ReadMessageTemplate]/is_active_autoreply to the response with the 200 status

      response-required-property-added

    • added the required property items/signature/allOf[ReadMessageTemplate]/signature to the response with the 200 status

      response-required-property-added

    • removed the required property items/is_starred from the response with the 200 status

      response-required-property-removed

    • removed the required property items/read_at from the response with the 200 status

      response-required-property-removed

    • added the required property items/sender_user to the response with the 200 status

      response-required-property-added

    • removed the required property items/sender_user from the response with the 200 status

      response-required-property-removed

    • added the required property items/read_at to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 575958bae45911See the full diff
    • removed the required property items/read_at from the response with the 200 status

      response-required-property-removed

    • added the required property items/sender_user to the response with the 200 status

      response-required-property-added