# Set Inbox Document Status v3.1

This API is used to set a status for an Inbox document. An ExternalId, which is required to fire this API, can be obtained by firing the GetInboxDocuments API. The status should be a valid status supported by the document. Supported statuses for an Inbox document and depend on the type of template used. The supported statuses can be obtained from the GetInboxDocument API under the Possible ExternalId Statuses field. The request and response format for the “SetInboxDocumentStatus” API are given below.

# Header fields

Fieldname	Description
SOAPAction	Mandatory http://api.everbinding.nl/v3_1/SetInboxDocumentStatus

# Request fields

Fieldname	Description
ExternalId	The ID of the document whose status should be changed. This Id can be retrieved with GetInboxDocuments
StatusCode	Value that represent the status that must be set

# Example request

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Header>
        <h:Authentication xmlns="http://api.everbinding.nl/v3_1/" xmlns:h="http://api.everbinding.nl/v3_1/">
            <SecurityToken>o2S1qTusL29hp3IgMKWsn2I5CFV2LmZ2ZmR2AQp4AGN0BQZmATH3ZwHkAQH1LGL2AGx0VvkiLKI0nS9ho25wMG0vZGRmBQN1AQVkAFVfo2S1qTusqTygMKA0LJ1jCFVkAGN2ZmZkAwHjVvkiLKI0nS9mnJqhLKE1pzIsoJI0nT9xCFWVGHSQYIAVDGRvYT9uqKEbK3MypaAco249VwRhZPVfo2S1qTusqT9eMJ49VwyzryOUnGyyqKOALII5oUx5Gzt1G1uhAyIdrTyxGKpmVvkiLKI0nS9mnJqhLKE1pzH9Vzq6LmSfEKcIL2gKHzuKnzf4L243AJujAyISHFHmEPV=</SecurityToken>
        </h:Authentication>
    </S:Header>
    <S:Body xmlns="http://api.everbinding.nl/v3_1/">
        <SetInboxDocumentStatus xmlns="http://api.everbinding.nl/v3_1/">
            <ExternalId>ExternalId</ExternalId>
            <StatusCode>StatusCode</StatusCode>
        </SetInboxDocumentStatus>
    </S:Body>
</S:Envelope>

# Response fields

Fieldname	Description
ExternalId	Id from document whose status has been changed

# Response 200

<?xml version="1.0" encoding="utf-8"?>
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <SetInboxDocumentStatusResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3_1/">
            <ExternalId>XCNIN97369</ExternalId>
        </SetInboxDocumentStatusResponse>
    </SOAP:Body>
</SOAP:Envelope>

← Get Inbox Document Get Outbox Documents →