Skip to main content
POST
/
users
Create a user
curl --request POST \
  --url https://api-joy.joyfill.io/v1/users \
  --header 'Content-Type: application/json' \
  --data '{
  "identifier": "<string>",
  "group": "<string>",
  "issueAccessToken": false,
  "accessTokenExpiration": "2023-11-07T05:31:56Z"
}'
"{\n  \"type\": \"String\",\n  \"identifer\": \"String\",\n  \"group\": \"String (optional)\",\n}"

Headers

​
Authorization
string

Supports both API Key and User Access Token authorization. See https://joyfill.mintlify.app/api/authentication

Body

application/json
​
identifier
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.

​
group
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.

​
issueAccessToken
boolean
default: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.

​
accessTokenExpiration
string<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.

Response

200

​
type
string
Example:

"String"

​
identifer
string
Example:

"String"

​
group
string
Example:

"String (optional)"

​
token
string
Example:

"String"