Internal Transfer

Update Internal Transfer

Updates mutable fields (like description or metadata) of an existing transfer object.

patch/v1/internal-transfers/{id}

Request

  • Base URL
    https://api.monime.io
  • URL
    https://api.monime.io/v1/internal-transfers/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID of the transfer to update.

Headers

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

descriptionstring nullable

Updated description for the transfer.

metadataobject nullable

Updated metadata for tagging this transfer.

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true

Changes

No recorded changes to this operation across all 2 revisions of this API.