Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
User sources

Updates an existing user_source.

patch/api/user-source/{user_source_id}/

Path parameters

user_source_idinteger required

The id of the user_source

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Request body

namestring
integration_idinteger

The related integration id.

table_idinteger nullable

The id of the Baserow table we want the data for.

email_field_idinteger nullable

The id of the field to use as email for the user account.

name_field_idinteger nullable

The id of the field that contains the user name.

role_field_idinteger nullable

The id of the field that contains the user role.

Response

idinteger required
uidstring required

Unique id for this user source.

application_idinteger required
integration_idinteger nullable required

The Integration used to establish the connection with the service.

typestring required

The type of the user_source.

namestring required
orderstring decimal required

Lowest first.

user_countinteger required

The total number of users in the user source.

user_count_updated_atstring date-time required

When the last user count took place.

table_idinteger nullable

The id of the Baserow table we want the data for.

email_field_idinteger nullable

The id of the field to use as email for the user account.

name_field_idinteger nullable

The id of the field that contains the user name.

role_field_idinteger nullable

The id of the field that contains the user role.