Skip to main content
DELETE
/
directory
/
chat-ops-onboarding-users
Remove users from chat ops onboarding
curl --request DELETE \
  --url https://api.wirespeed.co/directory/chat-ops-onboarding-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "size": 123,
  "page": 123,
  "filter": "email",
  "search": "<string>",
  "orderBy": "<string>",
  "orderDir": "asc",
  "teamId": "<string>",
  "tags": [
    "VIP"
  ],
  "ipId": "<string>",
  "endpointId": "<string>",
  "userAgentId": "<string>",
  "showUnmanagedUsers": true,
  "onlyEnabled": true,
  "onlyDisabled": true,
  "onlyContained": true,
  "onlyChatOpsOnboardingUsers": true,
  "onlyBillable": true,
  "integrationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": [
    {
      "id": "<string>",
      "displayName": "<string>",
      "teamId": "<string>",
      "additionalEmails": [
        "<string>"
      ],
      "allEmails": [
        "<string>"
      ],
      "createdAt": "<string>",
      "integrationId": {},
      "roles": [
        "<string>"
      ],
      "credentialsExposed": true,
      "numberCredentialExposures": 123,
      "containable": true,
      "smsInviteAttempts": 123,
      "tags": [
        {
          "id": "<string>",
          "directoryUserId": "<string>",
          "tag": "VIP",
          "automationId": "<string>",
          "teamId": "<string>",
          "overriddenByUser": true,
          "enabled": true,
          "createdAt": "<string>"
        }
      ],
      "enabled": true,
      "directoryId": "<string>",
      "name": "<string>",
      "phoneNumber": "<string>",
      "previousPhoneNumber": "<string>",
      "title": "<string>",
      "email": "<string>",
      "vip": true,
      "nhi": true,
      "financial": true,
      "technical": true,
      "managerDirectoryId": "<string>",
      "managerEmail": "<string>",
      "domain": "<string>",
      "department": "<string>",
      "lastCredentialExposure": {},
      "lastCheckedForCredentialExposures": {},
      "needsChatOpsWelcome": true,
      "contained": true,
      "username": "<string>",
      "smsConsentReceivedAt": {},
      "smsInviteLastSentAt": {},
      "smsInviteOptOut": true,
      "administrator": true,
      "updatedAt": "<string>",
      "passwordLastChangedAt": "<string>",
      "lastSignInAt": "<string>",
      "raw": {},
      "managed": true,
      "chatOpsOnboardingUser": true,
      "verifiedPhoneNumber": "<string>",
      "emailDirection": "sender",
      "integrationPlatform": "aws",
      "teamName": {}
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
size
number
page
number
filter
enum<string>

Field to filter directory users by

Available options:
email,
name,
username,
title,
department,
role
orderBy
string
orderDir
enum<string>
Available options:
asc,
desc
teamId
string

Filter users by team ID (for service providers)

tags
enum<string>[]

Filter users by tags

Available options:
VIP,
ADMIN,
TECHNICAL,
FINANCIAL,
NHI
ipId
string

Filter users associated with specific IP address

endpointId
string

Filter users associated with specific endpoint

userAgentId
string

Filter users associated with specific user agent

showUnmanagedUsers
boolean

Include unmanaged users in results

onlyEnabled
boolean

Only include users that are enabled

onlyDisabled
boolean

Only include users that are disabled

onlyContained
boolean

Only include users that are contained

onlyChatOpsOnboardingUsers
boolean

Only include users that are in the chat ops onboarding group

onlyBillable
boolean

Only include billable users

integrationIds
string<uuid>[]

Filter users by integration IDs (sources)

Response

data
object[]
required

Array of directory user search results

totalCount
number
required

Total count of directory users matching the search criteria