AddUserOnboarding

POST

https://api.upbooks.io/api/v1/user/add

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

name

string

required

string

required

type

enum<string>

required

Allowed values:

organization-adminstaff

secret

string

required

teams

array[string] | null

optional

Allowed values:

adminsalesfinancehrpurchaseoperationspre-sales

sso

optional

Any of

SSOEnum

number | null

Allowed values:

googlemicrosoftlinkedinapple

addEmployeeRecord

boolean | null

optional

inviteCode

string | null

optional

Example

{
    "name": "string",
    "email": "string",
    "type": "organization-admin",
    "secret": "string",
    "teams": [
        "admin"
    ],
    "sso": "google",
    "addEmployeeRecord": true,
    "inviteCode": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.upbooks.io/api/v1/user/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "string",
    "type": "organization-admin",
    "secret": "string",
    "teams": [
        "admin"
    ],
    "sso": "google",
    "addEmployeeRecord": true,
    "inviteCode": "string"
}'

Responses

🟢200Ok

application/json

Body

data

required

message

string

optional

Example

{
    "data": null,
    "message": "string"
}

Modified at 2024-03-29 12:32:24

DeleteUser

GetOrganizationByUser