API Reference
  1. Pencil Spaces API
  2. users

Modify user properties

patch
https://staging-apis.pencilapp.com/public/api/users/

This endpoint allows modification of user attributes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the user to be modified.

Body Params
string

The user's updated name.

string

External user identifier.

siteIds
array of strings

Array of site IDs that the user belongs to. This field is applicable only for institutions with sites. If the user being patched is an institution admin and the institution is site-enabled, the siteIds array is not required.

siteIds
customAttributeList
string

BCP 47 language code for the user's preferred language. Optional; defaults to "en" (English) if not provided.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?