Update ({collection.name})

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.
For more info and examples you could check the detailed Files upload and handling docs .

${JSON.stringify(Object.assign({}, baseData, CommonHelper.dummyCollectionSchemaData(collection)), null, 2)}; final record = await pb.collection('${collection?.name}').update('RECORD_ID', body: body); `} />
API details
PATCH

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

{#if adminsOnly}

Requires admin Authorization:TOKEN header

{/if}
Path parameters
Param Type Description
id String ID of the record to update.
Body Parameters
{#if collection?.isAuth} {/if} {#each collection?.schema as field (field.name)} {/each}
Param Type Description
Auth fields
Optional username
String The username of the auth record.
Optional email
String The auth record email address.
This field can be updated only by admins or auth records with "Manage" access.
Regular accounts can update their email by calling "Request email change".
Optional emailVisibility
Boolean Whether to show/hide the auth record email when fetching the record data.
Optional oldPassword
String Old auth record password.
This field is required only when changing the record password. Admins and auth records with "Manage" access can skip this field.
Optional password
String New auth record password.
Optional passwordConfirm
String New auth record password confirmation.
Optional verified
Boolean Indicates whether the auth record is verified or not.
This field can be set only by admins or auth records with "Manage" access.
Schema fields
{#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": {"relField1": {...}, ...}`}). 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}