message
post/api/v1/message/
Request
- The document declares no server URL.
- Auth: one of:
- OAuth 2 (scopes: write:message)
- API key in cookie sessionid
Query parameters
format'csv' | 'json'
Request body
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
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
- info
endpoint added
- info