Set a team's default override
PUT /fields/{id}/default-overrides/{team_id}
Sets the upload default one team uses for this field instead of the
field’s own default. Requires the fields.admin or system.admin
capability, granted globally; you don’t need to belong to the team.
The body is a complete default, checked the same way as the field’s
own default_value: against the field’s type and, for vocabulary
fields, against the field’s current terms, where only active terms
are accepted. Only asset fields can have upload defaults, and the
team must exist and not be deleted. Setting an override again
replaces the earlier one.
When an asset is created, the override is used if the uploader
belongs directly to this team and to no other team that overrides
the same field; with two or more such teams, the field’s own default
is used instead. The asset’s own team plays no part. Overrides apply
only to active fields, only on asset types the field applies to, and
never replace a value the asset already has. If the override can’t
be filled in, for example uploading_team for someone in more than
one team, the field gets no default at all; the field’s own default
isn’t used instead. Later changes to the field’s terms aren’t
checked against stored overrides.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The field definition’s id.
The team’s id.
Request Body required
Section titled “Request Body required ”An upload default: either a fixed value (literal) or a value the
server fills in when the asset is created (context). It is never a
formula.
For a literal, set only the value_* member the field’s type uses;
setting another member is refused with 400. On select,
multi_select and tree fields the slugs must be active terms of
the field. Upload defaults suit values chosen in advance; values
read from the file come from metadata extraction instead.
object
literal for a fixed value, context for one the server fills in when the asset is created.
The literal value for text, longtext, rich_text, select and tree fields. For select and tree, an active slug.
The literal value for number and boolean fields. A boolean is 1 or 0.
The literal value for date and datetime fields.
The literal value for multi_select fields: active slugs.
The literal value for reference fields: an asset id.
Required when kind is context, and not allowed otherwise. The
server fills in the value when the asset is created:
uploading_user: the uploader’s full name from their account, or their username if no full name is set. Use it on text fields.uploading_team: the name of the uploader’s team. Use it on text fields. Skipped when the uploader belongs to no team or to more than one.current_date: the creation time, fordateanddatetimefields. Adatefield gets the day (UTC), adatetimefield the exact time.
These three are the only choices.
Responses
Section titled “ Responses ”The stored override.
One team’s override of a field’s upload default.
object
The field definition’s id.
The team’s id.
The team’s slug.
The team’s name.
An upload default: either a fixed value (literal) or a value the
server fills in when the asset is created (context). It is never a
formula.
For a literal, set only the value_* member the field’s type uses;
setting another member is refused with 400. On select,
multi_select and tree fields the slugs must be active terms of
the field. Upload defaults suit values chosen in advance; values
read from the file come from metadata extraction instead.
object
literal for a fixed value, context for one the server fills in when the asset is created.
The literal value for text, longtext, rich_text, select and tree fields. For select and tree, an active slug.
The literal value for number and boolean fields. A boolean is 1 or 0.
The literal value for date and datetime fields.
The literal value for multi_select fields: active slugs.
The literal value for reference fields: an asset id.
Required when kind is context, and not allowed otherwise. The
server fills in the value when the asset is created:
uploading_user: the uploader’s full name from their account, or their username if no full name is set. Use it on text fields.uploading_team: the name of the uploader’s team. Use it on text fields. Skipped when the uploader belongs to no team or to more than one.current_date: the creation time, fordateanddatetimefields. Adatefield gets the day (UTC), adatetimefield the exact time.
These three are the only choices.
When the override was first set. Setting it again keeps this time.
When the override was last set.
The account that last set the override.
Malformed request
object
Human-readable error summary
Example
the request could not be completedAuthentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completedResource not found
object
Human-readable error summary
Example
the request could not be completed