Skip to main content
PUT
/
directory
/
automation
Create directory automation
curl --request PUT \
  --url https://api.wirespeed.co/directory/automation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "field": "email",
  "search": "<string>",
  "tag": "VIP"
}
'
{
  "id": "<string>",
  "teamId": "<string>",
  "searchField": "email",
  "search": "<string>",
  "enabled": true,
  "tag": "VIP",
  "searchType": "text"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
field
enum<string>
required

Field to search on for automation

Available options:
email,
name,
username,
title,
department,
role
​
search
string
required

Search expression to match users (1-512 characters)

​
tag
enum<string>
required

Tag to automatically assign to matching users

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

Response

​
id
string
required

Unique identifier for the automation

​
teamId
string
required

Team ID that owns this automation

​
searchField
enum<string>
required

Field to search on for this automation

Available options:
email,
name,
username,
title,
department,
role
​
search
string
required

Search expression for matching users

​
enabled
boolean
required

Whether the automation is currently enabled

​
tag
enum<string>
required

Tag to automatically assign to matching users

Available options:
VIP,
ADMIN,
TECHNICAL,
FINANCIAL,
NHI
​
searchType
enum<string>
required

Type of search pattern (text or regexp)

Available options:
text,
regexp