UpdateUser

PUT

https://api.upbooks.io/api/v1/user/{id}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

name

string

required

string

required

type

enum<string>

required

Allowed values:

superadminorganization-user

teams

array[string] | null

optional

Allowed values:

adminsalesfinancehrpurchaseoperationspre-sales

secret

string | null

optional

emailUnsubscribe

boolean | null

optional

Example

{
    "name": "string",
    "email": "string",
    "type": "superadmin",
    "teams": [
        "admin"
    ],
    "secret": "string",
    "emailUnsubscribe": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.upbooks.io/api/v1/user/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "email": "string",
    "type": "superadmin",
    "teams": [
        "admin"
    ],
    "secret": "string",
    "emailUnsubscribe": true
}'

Responses

🟢200Ok

application/json

Body

data

required

message

string

optional

Example

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

🟢200Success

Modified at 2024-04-15 09:07:15

GetUserDetail

DeleteUser