Change a search
updateRoleSearchChange a Search's title, criteria or schedule, or pause or resume it. Only whoever started it or a team owner can change it. Changes apply from the next run.
criteria replaces the whole list (up to 5, each { id, text }); keep the ids of criteria you keep, from getRoleSearch. cadence is off, daily or weekly; weekly runs on weekday (0 = Sunday). sendHour is the hour in the company's time zone. maxNew caps new people per run. includeOutside also searches outside Clera, which uses more credits. Tell the user what will change and get a yes before calling.
Clera privately records this tool's inputs and results for usage tracking and support.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"roleSearchId": "<roleSearchId>"
},
"name": "updateRoleSearch"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgId | No | Organization to act as. Only needed when you belong to more than one organization. | |
| title | No | ||
| maxNew | No | ||
| paused | No | ||
| cadence | No | ||
| weekday | No | ||
| criteria | No | ||
| sendHour | No | ||
| roleSearchId | Yes | ||
| skipWeekends | No | ||
| includeOutside | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| jobId | Yes | ||
| title | Yes | ||
| counts | Yes | ||
| prompt | Yes | ||
| status | Yes | ||
| newCount | Yes | ||
| roleName | Yes | ||
| schedule | Yes | ||
| canManage | Yes | ||
| createdAt | Yes | ||
| expiresAt | Yes | ||
| lastRunAt | Yes | ||
| nextRunAt | Yes | ||
| runNumber | Yes | ||
| requestedBy | Yes | ||
| qualityFloor | Yes |