Add an attachment

post

https://mapi-sandbox.unimaze.com/api/v1/messages/{messageId}/documents

Attaches a document to an existing message.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

A new document can be added to an exiting message by uploading a raw binary format (application/octet-stream). You can also submit the data as a stream that is formatted as a base64-encoded ASCII text. In this case, the HTTP Content-Type header must be set to application/base64

The document must be sent as the request body.

When the data is uploaded, the call then informs the server of whether more data is expected or not and updates the message status. If no more documents will be added, the call sets the status of the message to received. Otherwise, the message remains open and the message status is notset

The call throws an exception if the message does not exist or if it has already been closed, which means that its message status is received.

Path Params

messageId

uuid

required

The identifier of the message in the format of a valid Universally unique identifier (GUID).

Query Params

boolean

required

Signals if the current document is the last document that the message is supposed to contain.
If that is true, the processing starts immediately.

Name

string

required

The name of the document.
The value must be unique in the context of the message.

ContentType

string

required

The media type (MIME type) of the document.
For XML documents, the media type is text/xml.
This is used for display and processing control.

Encoding

string

The encoding used for displaying text documents.
For XML documents, examples include utf-8 and iso-8859-1.

Namespace

string

The namespace of the document.
The parameter is informative and might be used for XML documents, where it corresponds to the namespace of the XML document.

EmbedDocument

boolean

Whether the document should be embedded into the xml.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Message information

400Invalid input parameters.

422The request was understood but could not be processed.