Sign in
message

Changed on
patch/api/v1/message/{id}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (scopes: write:message)
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this Freedom of Information Message.

Query parameters

format'csv' | 'json'

Request body

resource_uristring uri
idinteger
urlstring
requeststring uri
sentboolean
is_responseboolean
is_postalstring
is_draftboolean
kind'email' | 'post' | 'fax' | 'upload' | 'phone' | 'visit' | 'import'
  • email - email
  • post - postal mail
  • fax - fax
  • upload - upload
  • phone - phone call
  • visit - visit in person
  • import - automatically imported
is_escalationboolean
content_hiddenboolean
sender_public_bodystring uri nullable
recipient_public_bodystring uri nullable
timestampstring date-time
registered_mail_datestring date-time nullable
redactedboolean
not_publishableboolean
attachmentsstring
subjectstring
contentstring
redacted_subjectstring
redacted_contentstring
senderstring
status_namestring
last_modified_atstring date-time

Response

resource_uristring uri required
idinteger required
urlstring required
requeststring uri required
sentboolean required
is_responseboolean
is_postalstring required
is_draftboolean
kind'email' | 'post' | 'fax' | 'upload' | 'phone' | 'visit' | 'import'
  • email - email
  • post - postal mail
  • fax - fax
  • upload - upload
  • phone - phone call
  • visit - visit in person
  • import - automatically imported
is_escalationboolean required
content_hiddenboolean required
sender_public_bodystring uri nullable
recipient_public_bodystring uri nullable
timestampstring date-time
registered_mail_datestring date-time nullable
redactedboolean
not_publishableboolean required
attachmentsstring required
subjectstring required
contentstring required
redacted_subjectstring required
redacted_contentstring required
senderstring required
status_namestring required
last_modified_atstring date-time required

Changes

  • 2ba1a8b828b8Revision changes
    • breaking

      request property was restricted to a list of enum values (media type: application/json)

    • breaking

      request property was restricted to a list of enum values (media type: application/x-www-form-urlencoded)

    • breaking

      request property was restricted to a list of enum values (media type: multipart/form-data)

    • breaking

      the request property type changed from no type to string (media type: application/json)

    • breaking

      the response property became optional for the status (media type: application/json)

    • breaking

      the response property became optional for the status (media type: text/csv)

    • breaking

      the response property became optional for the status (media type: application/json)

    • breaking

      the response property became optional for the status (media type: text/csv)

    • breaking

      the response property became optional for the status (media type: application/json)

    • breaking

      the response property became optional for the status (media type: text/csv)

    • breaking

      the response's property type changed from no type to string for status (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • warning

      added the new email enum value to the response property for the response status (media type: application/json)

    • warning

      added the new email enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new fax enum value to the response property for the response status (media type: application/json)

    • warning

      added the new fax enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new import enum value to the response property for the response status (media type: application/json)

    • warning

      added the new import enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new phone enum value to the response property for the response status (media type: application/json)

    • warning

      added the new phone enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new post enum value to the response property for the response status (media type: application/json)

    • warning

      added the new post enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new upload enum value to the response property for the response status (media type: application/json)

    • warning

      added the new upload enum value to the response property for the response status (media type: text/csv)

    • warning

      added the new visit enum value to the response property for the response status (media type: application/json)

    • warning

      added the new visit enum value to the response property for the response status (media type: text/csv)

    • info

      the request optional property became not read-only (media type: application/json)

    • info

      the request optional property became not read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became not read-only (media type: multipart/form-data)

    • info

      the request optional property became not read-only (media type: application/json)

    • info

      the request optional property became not read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became not read-only (media type: multipart/form-data)

    • info

      the request optional property became not read-only (media type: application/json)

    • info

      the request optional property became not read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became not read-only (media type: multipart/form-data)

    • info

      the request optional property became not read-only (media type: application/json)

    • info

      the request optional property became not read-only (media type: application/x-www-form-urlencoded)

    • info

      the request optional property became not read-only (media type: multipart/form-data)

    • info

      the request property default value true was added (media type: application/json)

    • info

      the request property default value true was added (media type: application/x-www-form-urlencoded)

    • info

      the request property default value true was added (media type: multipart/form-data)

    • info

      added the new email enum value to the request property (media type: application/json)

    • info

      added the new email enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new email enum value to the request property (media type: multipart/form-data)

    • info

      added the new fax enum value to the request property (media type: application/json)

    • info

      added the new fax enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new fax enum value to the request property (media type: multipart/form-data)

    • info

      added the new import enum value to the request property (media type: application/json)

    • info

      added the new import enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new import enum value to the request property (media type: multipart/form-data)

    • info

      added the new phone enum value to the request property (media type: application/json)

    • info

      added the new phone enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new phone enum value to the request property (media type: multipart/form-data)

    • info

      added the new post enum value to the request property (media type: application/json)

    • info

      added the new post enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new post enum value to the request property (media type: multipart/form-data)

    • info

      added the new upload enum value to the request property (media type: application/json)

    • info

      added the new upload enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new upload enum value to the request property (media type: multipart/form-data)

    • info

      added the new visit enum value to the request property (media type: application/json)

    • info

      added the new visit enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new visit enum value to the request property (media type: multipart/form-data)

    • info

      the request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the request property type was generalized from no type to string (media type: multipart/form-data)

    • info

      removed from the response property allOf list for the response status (media type: application/json)

    • info

      removed from the response property allOf list for the response status (media type: text/csv)

    • info

      the response's property default value true was added for the status (media type: application/json)

    • info

      the response's property default value true was added for the status (media type: text/csv)

    • info

      the response required property became not read-only for the status (media type: application/json)

    • info

      the response required property became not read-only for the status (media type: text/csv)

    • info

      the response required property became not read-only for the status (media type: application/json)

    • info

      the response required property became not read-only for the status (media type: text/csv)

    • info

      the response required property became not read-only for the status (media type: application/json)

    • info

      the response required property became not read-only for the status (media type: text/csv)

    • info

      the response required property became not read-only for the status (media type: application/json)

    • info

      the response required property became not read-only for the status (media type: text/csv)

  • f66b5d75cfd8Revision changes
    • breaking

      added to the request property allOf list (media type: application/json)

    • breaking

      added to the request property allOf list (media type: application/x-www-form-urlencoded)

    • breaking

      added to the request property allOf list (media type: multipart/form-data)

    • breaking

      removed from the request property oneOf list (media type: application/json)

    • breaking

      removed from the request property oneOf list (media type: application/x-www-form-urlencoded)

    • breaking

      removed from the request property oneOf list (media type: multipart/form-data)

    • breaking

      added to the response property oneOf list for the response status (media type: application/json)

    • breaking

      added to the response property oneOf list for the response status (media type: text/csv)

    • warning

      removed from the request property allOf list (media type: application/json)

    • warning

      removed from the request property allOf list (media type: application/x-www-form-urlencoded)

    • warning

      removed from the request property allOf list (media type: multipart/form-data)

    • info

      the endpoint scheme security oauth2 was added to the API

    • info

      added to the request property oneOf list (media type: application/json)

    • info

      added to the request property oneOf list (media type: application/x-www-form-urlencoded)

    • info

      added to the request property oneOf list (media type: multipart/form-data)

    • info

      added to the response property allOf list for the response status (media type: application/json)

    • info

      added to the response property allOf list for the response status (media type: text/csv)

    • info

      removed from the response property allOf list for the response status (media type: application/json)

    • info

      removed from the response property allOf list for the response status (media type: text/csv)

    • info

      removed from the response property oneOf list for the response status (media type: application/json)

    • info

      removed from the response property oneOf list for the response status (media type: text/csv)