Update attachments

  • Article

Update the attachment in Business Central. An attachment in the Business Central API is defined as an Incoming Document (table 130).

HTTP request

Replace the URL prefix for Business Central depending on environment following the guideline.

PATCH businesscentralPrefix/companies({companyId})/attachments({attachmentId})/attachmentContent

Request headers

Header Value
Authorization Bearer {token}. Required.
Content-Type application/json
If-Match Required. When this request header is included and the eTag provided does not match the current tag on the attachment, the attachments will not be updated.

Request body

In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

Response

If successful, this method returns a 200 OK response code and an updated attachment object in the response body.

Example

Request Here is an example of the request.

PATCH https://{businesscentralPrefix}/api/v2.0/companies({companyId})/attachments(parentId={parentId},id={attachmentId})/attachmentContent

Request body Request body contains the attachment.

Response

Here is an example of the response.

HTTP/1.1 200 OK
Content-type: application/json
{
    "id" : ,
    "parentId" : ,
    "fileName" : ,
    "byteSize" : ,
    "attachmentContent" : ,
    "lastModifiedDateTime" : ,
    "parentType" :
}

Tips for working with the APIs
attachment
Get attachment
Delete attachment
Create attachment