Skip to navigation
API ReferenceProject Templates

✨ Update a project template

Label Studio Enterprise badge

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

Update the details of a specific project template by ID for an organization.

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: 

curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"

Path parameters

idintegerRequired

Request

This endpoint expects an object.
assignment_settingsanyOptional
general dict serialized assignment settings
created_byinteger or nullOptional
custom_scriptstring or nullOptional>=1 character

custom script (Plugin) for projects created from this template

descriptionstring or nullOptional>=1 character
namestringOptional1-1000 characters
organizationinteger or nullOptional
project_idintegerOptional
project_settingsanyOptional
general dict serialized project settings
require_comment_on_skipbooleanOptional
flag to require comment on skip
review_settingsanyOptional
general dict serialized review settings
show_unused_data_columns_to_annotatorsboolean or nullOptional
tagsanyOptional

Response

This endpoint returns an object.
created_atdatetimeRead-only
idintegerRead-only
namestring<=1000 characters
updated_atdatetimeRead-only
assignment_settingsanyOptional
general dict serialized assignment settings
created_byinteger or nullOptional
custom_scriptstring or nullOptional

custom script (Plugin) for projects created from this template

descriptionstring or nullOptional
organizationinteger or nullOptional
project_settingsanyOptional
general dict serialized project settings
require_comment_on_skipbooleanOptional
flag to require comment on skip
review_settingsanyOptional
general dict serialized review settings
show_unused_data_columns_to_annotatorsboolean or nullOptional
tagsanyOptional