SurveyTale API Docs

Create a new user in the database.<br />Only available for self-hosted SurveyTale.

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Path Parameters

organizationId*string

The ID of the organization

Match^[0-9a-z]+$

Formatcuid2

Request Body

application/json

The user to create

TypeScript Definitions

Use the request body type in TypeScript.

isActive?boolean

Whether the user is active

name*string

The name of the user

Match^[\p{L}\p{M} ',()\d-]+$

Length1 <= length

email*string

The email of the user

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 255

role*string

The role of the user in the organization

Value in"owner" | "manager" | "member"

teams?array<string>

The list of teams the user is a member of

Response Body

`application/json`

curl -X POST "https://example.com/organizations/string/users" \  -H "Content-Type: application/json" \  -d '{    "name": "John Doe",    "email": "example@example.com",    "role": "member"  }'

{
  "id": "string",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "lastLoginAt": "2021-01-01T00:00:00.000Z",
  "isActive": true,
  "name": "John Doe",
  "email": "example@example.com",
  "role": "member",
  "teams": [
    "team1",
    "team2"
  ]
}