PATCH

/api/collections/{collection.name}/records/:id

{#if adminsOnly}

Requires Authorization: Admin TOKEN header

{/if}

Update a single {collection.name} record.

Body parameters could be sent as application/json or multipart/form-data.

File upload is supported only via multipart/form-data.

Client SDKs example
{ ... }; final record = await client.records.update('${collection?.name}', 'RECORD_ID', body: body); `} />
Path parameters
Param Type Description
id String ID of the record to update.
Body Parameters
{#each collection?.schema as field (field.name)} {/each}
Param Type Description
{#if field.required} Required {:else} Optional {/if} {field.name}
{CommonHelper.getFieldValueType(field)} {#if field.type === "text"} Plain text value. {:else if field.type === "number"} Number value. {:else if field.type === "json"} JSON array or object. {:else if field.type === "email"} Email address. {:else if field.type === "url"} URL address. {:else if field.type === "file"} File object.
Set to null to delete already uploaded file(s). {:else if field.type === "relation"} Relation record {field.options?.maxSelect > 1 ? "ids" : "id"}. {:else if field.type === "user"} User {field.options?.maxSelect > 1 ? "ids" : "id"}. {/if}
Query parameters
Param Type Description
expand String Auto expand relations when returning the updated record. Ex.: Supports up to 6-levels depth nested relations expansion.
The expanded relations will be appended to the record under the @expand property (eg. {`"@expand": {"rel1": {...}, ...}`}). Only the relations that the user has permissions to view will be expanded.
Responses
{#each responses as response (response.code)} {/each}
{#each responses as response (response.code)}
{/each}