API Reference
  1. Pencil Spaces API
  2. users

Create an API-managed user

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

Creates an API-managed user in your institution

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

The user's name

string
enum
required

The desired role for the user. Note: you can't programmatically create an API-managed user with an InstitutionAdmin role.

Allowed:
string

External user identifier. Optional.

siteIds
array of strings

Array of site IDs that the create api user belongs to. This field is required and applicable only for institutions with sites.

siteIds
customAttributeList
string

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

Responses

404

A user with the provided userId could not be found

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?