Update an existing image profile.

put

https://example.com/authoring/v1/image-profiles/{id}

Use the /image-profiles/{id} end-point to update an existing image profile within the database.
User roles: admin, manager

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the image profile document to update.

Query Params

forceOverride

boolean

Defaults to false

Specifies whether revision checking should be disabled.

Body Params

Contains the updated image profile object to save.

An existing image profile.

string

length ≥ 1

The ID of the image profile.

rev

string

required

length ≥ 1

The current revision of the image profile.

name

string

required

length ≥ 1

The name of the image profile.

description

string

The description of the image profile.

classification

enum

required

Allowed:

creatorId

string

required

length ≥ 1

The ID of the user that created the image profile.

creator

string

The display name of the user that created the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
This field is read only.

created

date-time

length ≥ 1

The created date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

lastModifierId

string

length ≥ 1

The ID of the user that last modified the image profile.

lastModifier

string

The display name of the last user that modified the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
This field is read only.

lastModified

date-time

length ≥ 1

The last modified date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

200Success.

400Invalid ID or Invalid input.

401The user is not authorized to run this action.

404The document with ID {id} was not found OR Current tenant's database is not provisioned.

409Another user updated the document since it was last retrieved OR when changing the document name, there is an existing document with the chosen name.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

500Unexpected error.