Skip to navigation
API ReferenceDocumentsProvider Documents

Update provider document

Update document name and/or type. Only fields sent are changed. The file itself cannot be replaced.

Authentication

AuthorizationBearer
API key issued for your account. Send as Bearer token in the Authorization header.
X-Plan-Manager-Idstring
Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

provider_idstringRequiredformat: "uuid"
Provider UUID
document_idstringRequired

Document id (bigint as string)

Request

This endpoint expects an object.
document_namestringOptional>=1 character
document_typestringOptional

Response

Updated document
idstring

Document id (bigint as string)

created_atdatetimeOptional
providerstringOptionalformat: "uuid"
document_namestringOptional
document_typestringOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error