Skip to content

Update a project ​

PUThttps://projects-api.transkribus.org/v1/projects/{id}

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Request Body​

application/json
Max Length255
Max Length2000
Valid values"active""archived""deleted"

Project visibility. Changing to non-private requires Owner or Admin role. Organisation requires owner to belong to an organisation.

Valid values"private""public""organisation"

URL to project image

Format"uri"

Country related to the documents

City related to the documents

Start year of time period

Minimum0
Maximum9999

End year of time period

Minimum0
Maximum9999

Languages used in documents

Institution or archive name

Type of documents (e.g., letters, ledgers)

Optional array of collection IDs to sync (replaces existing)

Optional array of site IDs to sync (replaces existing)

Optional array of model IDs to sync (replaces existing)

Responses​

Project updated successfully

Try it out

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Transkribus Developer Platform