PUT {who}/Messages/{messageId}/Archive?language={language}

Attempts to archive an existing Correspondence in Altinn.

Request Information

Parameters

NameDescriptionAdditional information
who Who the message should be instantiated for. Valid values are "my", or an organization number of an organization the user can represent, or <Reportee.ReporteeId>, where the identified reportee may be a person or organization.

Define this parameter in the request URI.

messageId The id of the message that are to be updated.

Define this parameter in the request URI.

language Language, valid values are: 1033 (English), 1044 (Bokmal) and 2068 (Nynorsk)

Define this parameter in the request URI.

Request body formats

application/hal+xml

Sample:
<resource rel="message">
    <Type>FormTask</Type>
    <ServiceCode>string example 21</ServiceCode>
    <ServiceEdition>64</ServiceEdition>
    <resource rel="forms">
        <resource rel="form">
            <DataFormatId>string example 34</DataFormatId>
            <DataFormatVersion>string example 38</DataFormatVersion>
            <FormData><![CDATA[<Skjema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ...>...</Skjema>]]>
            </FormData>
        </resource>
    </resource>
    <resource rel="attachments">
        <resource rel="attachment">
            <FileName>string example 87</FileName>
            <AttachmentType>string example 89</AttachmentType>
            <Data>base64 encoded</Data>
        </resource>
    </resource>
</resource>
                    

application/hal+json

Sample:
{
    "Type": "FormTask",
    "ServiceCode": "string example 34",
    "ServiceEdition": 64,
    "_embedded" : {
        "forms" : [{
            "Type": "MainForm",
            "DataFormatId": "string example 36",
            "DataFormatVersion": "string example 38",
            "FormData": "<Skjema xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"...>...</Skjema>"
        }],
        "attachments" : [{
            "FileName": "string example 43",
            "AttachmentType": "string example 43",
            "Data": "base64 encoded"
        }]
    }
}
                    

Response body formats

application/hal+xml

No sample

application/hal+json

Sample:
{
    "UserName": "enterpriseuser123renamed",
    "Created": "2021-07-06T11:06:30.9786158+02:00",
    "OwnerOrgNo": "910494392"
}