Create a user

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

There are two different types of users within Joyfill: Organization Users and Group User. Learn about the two different types of users here: Users Overview

Create Organization User

Do not pass in a group identifier to the request body param. By leaving it empty you tell the API that the new user should be an organization user.

Create Group User

  • Create user for existing group - Pass the custom or Joyfill auto generated Group identifier, (The identifier is saved on the Joyfill Group under the group.identifier property) to the request body group param.
  • Create user for non-existent group
    • Option 1: Create a new group via the Group API or Joyfill Manager and then use that new group in the create user request. See "Create user for existing group" above once you've created your new group.
    • Option 2: Pass a custom unique identifier to the request body group param. This will create a brand new group with the specified identifier and automatically assign the new user to that new group and respond with the new user object.
Body Params
string

Specifies a user's unique ID. Maximum length is 80 characters. * Don't use personally identifiable information (PII) such as the user's email address, legal name, or phone number. Identifier cannot be changed after creation. Leave the identifier param empty to have Joyfill auto generate an identifier.

string

The identifier of the group you want to add the user to. If no group exists with the specified identifier then one will automatically be created.

boolean
Defaults to false

Determines whether to create an access token for the user. If set to true, an access token will be generated and returned in the token field. This token can be used in API request instead of API Keys.

date-time

Millisecond timestamp of token expiration date. Expired tokens will not be able to make API requests. Leave blank to issue an access token that never expires.

Headers
string

Supports both API Key and User Access Token authorization. See https://docs.joyfill.io/docs/authentication

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json