Users

User related APIs

Perform Bulk User Actions

post

Authorizations

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

actionstring · enumRequiredPossible values:

Responses

200

OK

application/json

post

HTTPcURLJavaScriptPython

POST /webapi/v2/users/bulk HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "action": "create",
  "users": [
    {
      "data": [
        {
          "key": "first_name",
          "value": "John"
        },
        {
          "key": "last_name",
          "value": "Doe"
        },
        {
          "key": "email",
          "value": "[email protected]"
        },
        {
          "key": "customer_group",
          "value": "HR"
        }
      ],
      "ownUserId": "A12345"
    }
  ]
}

200

OK

{
  "result": [
    {
      "ownUserId": "A12345",
      "status": "success"
    }
  ]
}

Get User

get

Authorizations

Path parameters

own_user_idstringRequired

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /webapi/v2/user/{own_user_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

{
  "result": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  }
}