Skip to main content
PUT
/
v2
/
clients
cURL
curl --request PUT \
  --url https://eu-vg-edge.moeaymandev.workers.dev/v2/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgId": "<string>",
  "name": "<string>",
  "squarePhotoURL": "<string>",
  "email": "<string>",
  "dashboardPassword": "<string>",
  "canAccess": [
    "/overview"
  ],
  "isOrgAdmin": true,
  "notificationsSettings": {
    "notifyThrough": "email",
    "notifyIf": "all"
  }
}
'
{
  "success": true,
  "message": "Client created successfully"
}

Authorizations

​
Authorization
string
header
required

Workspace secret API key, found in the workspace settings page (top left).

Body

application/json

Client to create

​
orgId
string

The org ID associated with the client.

​
name
string

The name of the client.

​
squarePhotoURL
string

URL to the square photo of the client.

​
email
string

The email address of the client (used as username to signin on dashboard).

​
dashboardPassword
string

Password for the client's dashboard (used as password to signin on dashboard).

​
canAccess
enum<string>[]

List of hrefs the client can access.

List of hrefs the client can access.

Available options:
/overview,
/home,
/convos,
/analytics,
/kb,
/settings
​
isOrgAdmin
boolean

Indicates if the client is an organization admin.

​
notificationsSettings
object

Notification settings for the client.

Response

Client created successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Client created successfully"