Admin MCP Tool Reference
25 tools. Generated 29-Sep-2026.
| Tool | Summary |
|---|---|
agent_api_create | Creates a new API agent in Conductrics — one your own code drives by requesting a variation and reporting goals through the Conductrics API or SDKs. |
agent_express_create | Creates a new Express agent in Conductrics — an on-page visual experiment run by the Conductrics Express script, where each variation changes the page via JavaScript. |
agent_list | Lists the agents in the Conductrics account. |
agent_get | Returns one agent in full: everything agent_list returns (including stage, goals and teams), plus its template, visitor conditions, variations, and — for Express agents — its change sets. |
agent_template_list | Lists the agent templates in the Conductrics account. |
agent_variation_add | Adds a new variation (choice) to an existing agent. |
agent_variation_remove | Removes a variation (choice) from an existing agent. |
agent_variation_js_set | Sets custom JavaScript for a specific variation in one change set of an Express agent, replacing that variation's existing script there (its first script, if it has several; agent_get shows it as change_sets[].variations[code].script). |
agent_variation_metadata_get | Returns the metadata key/value pairs for a specific variation of an agent. |
agent_variation_metadata_value_set | Sets or removes a single metadata key on a specific variation of an agent. |
agent_condition_fields_list | Returns all available visitor condition fields and operators for this Conductrics account. |
agent_conditions_set | Sets visitor eligibility conditions on an agent (replaces any existing conditions). |
agent_eligibility_js_set | Sets eligibility JavaScript and/or a DOM selector on one change set of an Express agent. |
agent_express_url_conditions_set | Sets the URL conditions on one change set of an Express agent, replacing any existing ones. |
agent_schedule_get | Returns the current schedule for an agent, including any pending "go Live" and "go Done" items. |
agent_schedule_live_unset | Removes any scheduled "go Live" transition from an agent. |
agent_schedule_done_set | Schedules an agent to automatically move to the Done stage at a given time. |
agent_schedule_done_unset | Removes any scheduled "go Done" transition from an agent. |
agent_stats_get | Retrieves reporting/stats for a specific agent. |
agent_saved_model_list | Lists the saved models for an adaptive (predictive) agent. |
agent_saved_model_get | Returns one saved model for an adaptive (predictive) agent, including the audiences it learned. |
goal_list | Lists all goals in the Conductrics account. |
goal_create | Creates a new goal (a conversion/metric that agents can be evaluated against) and optionally associates it with existing agents. |
goal_update | Updates an existing goal. |
agent_goals_set | Sets the goals associated with an agent, replacing the full set of existing associations. |
agent_api_create
Creates a new API agent in Conductrics — one your own code drives by requesting a variation and reporting goals through the Conductrics API or SDKs. Use this for server-side, mobile, or any experiment you integrate in code. For on-page visual experiments run by the Conductrics Express script, use agent_express_create instead.
An API template is REQUIRED: call agent_template_list first and pass a template whose agent_type is "api". The template supplies the variations, goal associations and other settings. Adjust the result afterwards with agent_variation_add / agent_variation_remove and agent_goals_set.
Agents are created in the Draft stage and must be moved on (to In QA or Live) by a human.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
code | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Unique code (identifier) for this agent. Typically based on the human-readable name. Letters, numbers, dashes and underscores only; max 100 characters. |
name | string | yes | 1–75 chars | Human-readable name for the agent. Max 75 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
agent_template | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Required. Code of the template agent this agent is based on — call agent_template_list to see the available templates. The template supplies the variations, goal associations and other settings, so that agents created here follow the account's configured best practices. |
description | string | no | 1–250 chars | Optional agent description. Max 250 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
tags | string[] | no | Optional tags. Each may contain letters, numbers, dashes, underscores only; max 100 characters. Must not start with "c-" (reserved by Conductrics). |
agent_express_create
Creates a new Express agent in Conductrics — an on-page visual experiment run by the Conductrics Express script, where each variation changes the page via JavaScript. Use this for web/visual experiments. For experiments driven by your own code through the Conductrics API or SDKs, use agent_api_create instead.
An Express template is REQUIRED: call agent_template_list first and pass a template whose agent_type is "express". The template supplies the variations, URL conditions, goal associations and other settings. Adjust the result afterwards with agent_express_url_conditions_set, agent_variation_js_set, agent_eligibility_js_set, and agent_variation_add / agent_variation_remove.
Note that variation metadata is not supported for Express agents. Agents are created in the Draft stage and must be moved on (to In QA or Live) by a human.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
code | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Unique code (identifier) for this agent. Typically based on the human-readable name. Letters, numbers, dashes and underscores only; max 100 characters. |
name | string | yes | 1–75 chars | Human-readable name for the agent. Max 75 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
agent_template | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Required. Code of the template agent this agent is based on — call agent_template_list to see the available templates. The template supplies the variations, goal associations and other settings, so that agents created here follow the account's configured best practices. |
description | string | no | 1–250 chars | Optional agent description. Max 250 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
tags | string[] | no | Optional tags. Each may contain letters, numbers, dashes, underscores only; max 100 characters. Must not start with "c-" (reserved by Conductrics). |
agent_list
Lists the agents in the Conductrics account. Each agent includes its agent_type ("api" or "express") and its associated goals (the conversions/metrics it is evaluated against) as an array of {code, name} objects. Template agents are excluded — use agent_template_list for those.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agent_type | "api" | "express" | no | Optional filter: return only agents of this type. Omit to return every agent, each labelled with its agent_type. | |
tags | string[] | no | Optional filter: return only agents with these tags. |
agent_get
Returns one agent in full: everything agent_list returns (including stage, goals and teams), plus its template, visitor conditions, variations, and — for Express agents — its change sets. Fields that a setter changes use that setter's names and shapes, so they can be edited and passed straight back:
- conditions → agent_conditions_set
- variations[].meta (API agents) → agent_variation_metadata_value_set (null removes a key)
- express.change_sets[] (Express agents): url_conditions → agent_express_url_conditions_set; eligibility → agent_eligibility_js_set; variations[code].script → agent_variation_js_set. Pass the change set's id as changeSetId; it is required when there are several change sets, and it changes whenever the change set is edited.
"notes" explains anything about the agent this server can't show or change. Goal associations are stored on the goals, so changing them does not change updated_at.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to return. |
agent_template_list
Lists the agent templates in the Conductrics account. A template carries the settings an account wants applied consistently to new agents — variations, goal associations, and options this MCP server has no tools for — so that agents created here follow those best practices without anyone configuring them by hand afterwards.
Creating an agent REQUIRES a template of the matching type, so call this first: agent_api_create needs a template whose agent_type is "api", and agent_express_create needs one whose agent_type is "express". If this returns nothing, the account has no templates and agents cannot be created through this server until one exists.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agent_type | "api" | "express" | no | Optional filter: return only templates of this type. Pass "express" when creating an Express agent and "api" when creating an API agent, since each create tool requires a template of its own type. Omit to return every template, each labelled with its agent_type. | |
tags | string[] | no | Optional filter: return only templates with these tags. |
agent_variation_add
Adds a new variation (choice) to an existing agent. The agent must be in the Draft stage.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to add the variation to. |
variationCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code for the new variation. Letters, numbers, dashes and underscores only; max 100 characters. |
variationName | string | yes | 1–50 chars | Human-readable variation name. Max 50 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
meta | record<string, string | number | boolean> | no | Optional metadata key/value pairs for the new variation. |
agent_variation_remove
Removes a variation (choice) from an existing agent. The agent must be in the Draft stage. An agent must keep at least two variations, so the last two cannot be removed. For an Express agent, the variation's JavaScript and other changes are removed from every change set along with it.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to remove the variation from. |
variationCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the variation to remove. |
agent_variation_js_set
Sets custom JavaScript for a specific variation in one change set of an Express agent, replacing that variation's existing script there (its first script, if it has several; agent_get shows it as change_sets[].variations[code].script). Other changes on the variation, such as ones made in the visual editor, are left in place. Settings you don't pass (selector, prehide, watch, watchSelector) keep their current values, or defaults for a new script. The agent must be in the Draft stage. Returns the change set's new id, for any follow-up edit to it.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the Express agent that owns the variation. |
variationCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the variation to attach the JavaScript to. |
changeSetId | string | no | pattern ^cs-[0-9a-f]{12}$ | Id of the change set to change (change_sets[].id from agent_get). Required when the agent has more than one change set; optional, but still checked, when it has one. A change set's id changes whenever it is edited, so use the id returned by your previous call for a follow-up edit; a stale id is refused. |
javascript | string | yes | The JS to execute for this variation. | |
selector | string | no | CSS selector that must match a DOM element before this variation's JS executes ("wait for"). Use it to delay execution until the target element exists. Empty string for none. | |
prehide | boolean | no | Whether to hide the element matched by selector until the variation JS has run, to avoid a flash of the original content. | |
watch | boolean | no | "Watch and reapply": keep watching after the first run, and re-run the JS when matching elements are added to the page later (single-page apps). Watches the elements matching selector, or watchSelector if given. Requires a selector. | |
watchSelector | string | no | A different CSS selector to watch when watch is on, instead of selector. Empty string to watch selector itself. |
agent_variation_metadata_get
Returns the metadata key/value pairs for a specific variation of an agent. Not supported for Express agents (those with the "c-wa" tag).
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent that owns the variation. |
variationCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the variation to read metadata from. |
agent_variation_metadata_value_set
Sets or removes a single metadata key on a specific variation of an agent. The agent must be in the Draft stage. Creates the key if it does not exist and overwrites it if it does; a metaValue of null removes the key (doing nothing if it is not there). Not supported for Express agents (those with the "c-wa" tag).
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent that owns the variation. |
variationCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the variation to modify. |
metaCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | The metadata key to set or remove. |
metaValue | string | number | boolean | null | yes | The value to set, or null to remove the key. |
agent_condition_fields_list
Returns all available visitor condition fields and operators for this Conductrics account. Call this before agent_conditions_set to discover valid field tokens, allowed operators, and predefined value codes. Fields are account-specific — custom traits differ per account.
Each field carries a "category" grouping it by what it matches. Fields with category "url" are the page/URL fields, and are the only ones valid for the URL conditions of an Express agent — pass category: "url" to get just those.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
category | string | no | min 1 chars | Optional filter: return only fields in this category. Pass "url" to get just the page/URL fields — the only ones valid for an Express agent's URL conditions (agent_express_url_conditions_set). Omit to return every field, each labelled with its own category. |
agent_conditions_set
Sets visitor eligibility conditions on an agent (replaces any existing conditions). The agent must be in the Draft stage. Conditions control which visitors are eligible to receive a variation from this agent. Call agent_condition_fields_list first to discover valid field tokens, operators, and value codes for this Conductrics account.
Conditions are a tree of groups. A group is an object with exactly one key — "all", "any" or
"none" — holding a list of conditions and/or nested groups:
"all": every item must match; "any": at least one must match; "none": no item may match.
Groups can be nested one level (a group inside the top-level group). A "none" group can only
hold conditions, not groups.
Each condition is value:
- field: the bare token from agent_condition_fields_list, e.g. "targ.ua/mo" (not "${targ.ua/mo}")
- op: an operator code that field allows, e.g. "is", "isnt", "gt", "sub"
- value: for fields with predefined values, the value code (e.g. "m" for mobile); otherwise the
raw string or number. "in", "nin", "has-any", "has-all" and "has-none" take an array of
values; "inr" and "ninr" take a [min, max] pair of numbers.
Example — mobile visitors on either landing page:
{"all": [
{ "field": "targ.ua/mo", "op": "is", "value": "m" },
{ "any": [
{ "field": "v.loc.qx", "op": "is", "value": "https://example.com/landing/" },
{ "field": "v.loc.qx", "op": "is", "value": "https://example.com/promo/" } ] } ]}
If an agent's existing conditions include any this format can't represent, they can't be
replaced here; the tool says so if you try.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to set conditions on. |
conditions | object | object | object | yes | A condition tree: {"all" | "any" | "none": [conditions and/or groups]}. |
agent_eligibility_js_set
Sets eligibility JavaScript and/or a DOM selector on one change set of an Express agent. The agent must be in the Draft stage. These control whether and when the agent activates for a given visitor, independently of the per-variation JS set by agent_variation_js_set. The agent must have the "c-wa" tag (i.e. be an Express agent). At least one of "javascript" or "selector" must be provided. Returns the change set's new id, for any follow-up edit to it.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the Express agent to configure. |
changeSetId | string | no | pattern ^cs-[0-9a-f]{12}$ | Id of the change set to change (change_sets[].id from agent_get). Required when the agent has more than one change set; optional, but still checked, when it has one. A change set's id changes whenever it is edited, so use the id returned by your previous call for a follow-up edit; a stale id is refused. |
javascript | string | no | JavaScript that runs to determine visitor eligibility. Must return true synchronously if the visitor should be considered eligible; any other return value (or no return) is treated as ineligible. | |
selector | string | no | CSS selector that must match a DOM element before the eligibility JS is executed. Use this to control initialization timing — the experiment will not run until the element appears on the page. |
agent_express_url_conditions_set
Sets the URL conditions on one change set of an Express agent, replacing any existing ones. The agent must be in the Draft stage. The agent must be an Express agent (created with agent_express_create).
Conditions must use only fields whose "category" is "url" — call agent_condition_fields_list and check each field's category. URL conditions control which pages the Express experiment runs on.
Conditions are a tree of groups. A group is an object with exactly one key — "all", "any" or
"none" — holding a list of conditions and/or nested groups:
"all": every item must match; "any": at least one must match; "none": no item may match.
Groups can be nested one level (a group inside the top-level group). A "none" group can only
hold conditions, not groups.
Each condition is value:
- field: the bare token from agent_condition_fields_list, e.g. "targ.ua/mo" (not "${targ.ua/mo}")
- op: an operator code that field allows, e.g. "is", "isnt", "gt", "sub"
- value: for fields with predefined values, the value code (e.g. "m" for mobile); otherwise the
raw string or number. "in", "nin", "has-any", "has-all" and "has-none" take an array of
values; "inr" and "ninr" take a [min, max] pair of numbers.
Example — mobile visitors on either landing page:
{"all": [
{ "field": "targ.ua/mo", "op": "is", "value": "m" },
{ "any": [
{ "field": "v.loc.qx", "op": "is", "value": "https://example.com/landing/" },
{ "field": "v.loc.qx", "op": "is", "value": "https://example.com/promo/" } ] } ]}
If an agent's existing conditions include any this format can't represent, they can't be
replaced here; the tool says so if you try.
These are distinct from agent_conditions_set, which sets visitor eligibility conditions on the agent as a whole. Returns the change set's new id, for any follow-up edit to it.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the Express agent to set URL conditions on. |
changeSetId | string | no | pattern ^cs-[0-9a-f]{12}$ | Id of the change set to change (change_sets[].id from agent_get). Required when the agent has more than one change set; optional, but still checked, when it has one. A change set's id changes whenever it is edited, so use the id returned by your previous call for a follow-up edit; a stale id is refused. |
conditions | object | object | object | yes | A condition tree using only category "url" fields: {"all" | "any" | "none": [conditions and/or groups]}. |
agent_schedule_get
Returns the current schedule for an agent, including any pending "go Live" and "go Done" items. Times are ISO 8601 strings in UTC.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent whose schedule should be returned. |
agent_schedule_live_unset
Removes any scheduled "go Live" transition from an agent.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to clear the "go Live" schedule from. |
agent_schedule_done_set
Schedules an agent to automatically move to the Done stage at a given time. Replaces any existing "go Done" schedule item. The agent must be in the Draft stage. Provide due_at as an ISO 8601 date/time including a timezone.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to schedule. |
due_at | string | yes | pattern `^(?:(?:\d\d[2468][048] | \d\d[13579][26] |
agent_schedule_done_unset
Removes any scheduled "go Done" transition from an agent.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to clear the "go Done" schedule from. |
agent_stats_get
Retrieves reporting/stats for a specific agent.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent to retrieve stats for. |
agent_saved_model_list
Lists the saved models for an adaptive (predictive) agent. A saved model is a snapshot of a built decision tree — the audience segmentation the agent learned at the time it was saved. Exactly one model is active (promoted), meaning the agent uses it to select variations at runtime; that one is flagged with is_active.
The list may include a synthetic entry with the code "(default)" and is_default true. That is not a stored snapshot but the live, automatically rebuilt model, and it appears whenever no saved model has been promoted. Producing it can require building the model on demand, so the first call for such an agent may take noticeably longer.
Use agent_saved_model_get to see the audiences inside any of these models. Times are ISO 8601 strings in UTC.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent whose saved models should be listed. |
agent_saved_model_get
Returns one saved model for an adaptive (predictive) agent, including the audiences it learned. Call agent_saved_model_list first to get a model code.
Each audience is one leaf of the model's decision tree: a combination of visitor features (conditions), the share of visitors it covers, and the variations ranked best-first with the model's estimated goal value for each. "overall" is the same thing across all visitors, before any audience split. Features and variations are reported with their display names alongside their codes; when names_resolved is false the lookup was unavailable and each name falls back to its code.
build_conf records the settings the model was built with. A model whose build has not finished comes back with tree_available false and no audiences. Times are ISO 8601 strings in UTC.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent that owns the model. |
modelCode | "(default)" | string | yes | Code of the saved model, as returned by agent_saved_model_list. Saved models have codes beginning "lm-"; the literal "(default)" addresses the live, automatically built model. | |
include_raw_tree | boolean | no | default false | Return the unflattened decision tree as well. Rarely needed — the audiences array already carries what the tree encodes, in a far smaller form. |
resolve_names | boolean | no | default true | Look up display names for features and variations. Set false to skip the two extra lookups and report codes only. |
goal_list
Lists all goals in the Conductrics account. Goals (also called conversions or metrics) are the events or measures that agents are evaluated against — often purchases or engagement metrics.
Takes no arguments.
goal_create
Creates a new goal (a conversion/metric that agents can be evaluated against) and optionally associates it with existing agents. By default a goal is a simple conversion counted at most once per visitor per agent (countMax = 1). Provide valueMin and valueMax together to make the goal accept a numeric value at runtime (e.g. a purchase amount); a numeric goal may also specify a default value via valueDef. Any agents listed in agent_codes must be in the Draft stage; each is checked before the goal is created.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
code | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Unique code (identifier) for this goal. Must not match an existing goal. Letters, numbers, dashes and underscores only; max 100 characters. |
name | string | yes | 1–50 chars | Human-readable name for the goal. Max 50 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
category | string | no | 1–50 chars | Optional category used to group related goals. Max 50 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
agent_codes | string[] | no | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Optional codes of existing agents to associate with this goal initially. Each agent must be in the Draft stage. |
countMax | integer | no | > 0 | Maximum number of times the goal can be observed per visitor (per agent). Optional; defaults to 1. |
valueMin | number | no | Optional. If provided, the goal accepts numeric values at runtime (e.g. purchase amount). valueMax must also be provided. | |
valueMax | number | no | Optional. Required if valueMin is provided. The maximum accepted numeric value. | |
valueDef | number | no | Optional default numeric value used when no value is provided at runtime. Only meaningful for numeric-valued goals (valueMin/valueMax set). |
goal_update
Updates an existing goal. Every field except the goal code is mutable. Only the fields you pass are changed — omit a field to leave it as it is, or pass null to clear it (name cannot be cleared). To change which agents a goal is associated with, use agent_goals_set instead.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
code | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the goal to update. The code itself cannot be changed. |
name | string | no | 1–50 chars | New name for the goal. Max 50 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. |
category | string | null | no | Category used to group related goals. Max 50 characters, no leading or trailing whitespace, and must not contain < > & " or tab/newline characters. Pass null to clear it. | |
countMax | integer | null | no | Maximum number of times the goal can be observed per visitor (per agent). Pass null to clear it. | |
valueMin | number | null | no | Minimum accepted numeric value. Set together with valueMax to make the goal numeric. Pass null to clear it. | |
valueMax | number | null | no | Maximum accepted numeric value. Pass null to clear it. | |
valueDef | number | null | no | Default numeric value used when none is provided at runtime. Only meaningful for numeric-valued goals. Pass null to clear it. |
agent_goals_set
Sets the goals associated with an agent, replacing the full set of existing associations. Pass an empty array to clear all goal associations. The agent must be in the Draft stage. Use goal_list to discover valid goal codes.
| Argument | Type | Required | Constraints | Description |
|---|---|---|---|---|
agentCode | string | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | Code of the agent whose goal associations should be replaced. |
goalCodes | string[] | yes | pattern ^[A-Za-z0-9_-]+$, 1–100 chars | The complete set of goal codes to associate with the agent (replaces any existing set). |
Updated 1 day ago