Skip to main content
PUT
Update Entity

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.
  • Change a record in a team’s database, or in a database shared with one of your teams: The permission is checked on the record’s owning team, or on a team the record’s database is shared with at “Can write”; a “Can read” share admits no write. A record in a database not shared with one of your teams is refused. Schema and row-access rules still apply.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of the entity. Editable in its owning team or through a team its database is shared with at "Can write"; a record of a database not shared with one of your teams is refused.

Body

application/json
fieldValues
EntityFieldValueInput · object[]

The field values to set. Only provided fields are updated; omitted fields are untouched.

name
string

Convenience field to update the entity's name. Sets the value of the entity type's name field (is_name_field). Ignored if field_values already contains a value for the name field.

Response

200 - application/json

Success

data
data · object

The updated entity.

pendingChange
EntityPendingChange · object | null