API Reference
  1. Pencil Spaces API
  2. users

Invite a user to the institution via their email

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

Invite a user by their email address to the institution

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

The name address of the user

string
required

The email address of the user

string
enum
required

The desired role for the user. Note: you can't programmatically invite a user as an InstitutionAdmin

Allowed:
string

External user identifier. Optional.

siteIds
array of strings

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

siteIds
customAttributeList
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?