PM administration
Administer PM users, groups, roles, and pick lists.
This area has 1 group and 12 tools, 10 of them currently available.
- Groups are the unit of access. An admin enables tool groups on a client registration, and a tool appears in an agent's tool list only when its group is enabled. See Tool Groups.
- Needs. Enabling a group also enables every group it needs. Each group below lists them.
- Read-only groups are intended for look-up access without the ability to change data.
- Visibility is not authorization. Every tool call executes as the authenticated user, and a visible tool can still return an authorization error. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Not currently available tools are registered but are not offered in any tool list at this time.
- Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Groups in this area
| Group | Access | Needs | Tools |
|---|---|---|---|
| Administer PM Users, Groups, Roles & Pick Lists | Can change data | Look Up PM Users, Groups & Roles, Look Up PM Reference Data | 12 |
Administer PM Users, Groups, Roles & Pick Lists
Can change data · 12 tools (10 currently available) · Group ID administer-pm-users-groups-roles
Needs: Look Up PM Users, Groups & Roles, Look Up PM Reference Data
| Tool | What it does |
|---|---|
create_pm_group | Creates a new group in Aprimo Marketing Operations. |
create_pm_user | Creates a new user in Aprimo Marketing Operations. |
create_user_role | Not currently available. Creates a new user role in Aprimo Marketing Operations. |
delete_pm_group | Destructive. Permanently deletes a group by id in Aprimo Marketing Operations. |
delete_pm_user | Destructive. Permanently deletes a user by id in Aprimo Marketing Operations. |
delete_user_role | Destructive. Permanently deletes a user role by id in Aprimo Marketing Operations. |
reset_user_pin | Destructive. Permanently resets a user's pin in Aprimo Marketing Operations, invalidating their existing authentication credential. |
update_allowed_child_pick_list_options | Not currently available. Updates the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's integer ID, in Aprimo Marketing Operations. |
update_pick_list_options | Updates the pick list options for an extended attribute, by the attribute's integer ID, in Aprimo Marketing Operations. |
update_pm_group | Updates an existing group by id in Aprimo Marketing Operations. |
update_pm_user | Updates an existing user by id in Aprimo Marketing Operations. |
update_user_role | Updates an existing user role by its integer ID in Aprimo Marketing Operations. |
create_pm_group
Creates a new group in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created group.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new group's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize. |
name | string (optional) | From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs). |
raw | object (optional) |
create_pm_user
Creates a new user in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new user's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess. |
name | string (optional) | Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known. |
rights | array of UserRightProjection (optional) | /// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it. |
rights[].functionId | integer | Same numbering space as api's UserRightsEnum (e.g. ProgramView = 15). |
rights[].functionName | string (optional) | |
rights[].domainId | integer | |
raw | object (optional) | The complete wire object, verbatim -- see the class remarks. |
create_user_role
Not currently available
Creates a new user role in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the created role.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
body | string | Yes | JSON object with the new role's data (PM wire names). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
roleId | integer | |
name | string (optional) | |
description | string (optional) | |
activeFlag | boolean (optional) | |
color | string (optional) | |
currencyCode | integer (optional) | |
usedInAnnotations | boolean (optional) | |
modifiedUserId | integer (optional) | |
modifiedUserName | string (optional) | |
modifiedDate | string (optional) | |
laborRateEntered | number (optional) | Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely. |
laborRateBase | number (optional) | Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
excludeFromChatboards | boolean (optional) | Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
delete_pm_group
Destructive
Permanently deletes a group by id in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact group with the user. Alternatively, identify the group by name instead of groupId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
groupId | string | No | The group's id to delete. Provide either groupId or name, not both. |
name | string | No | The group's name. Provide either groupId or name, not both. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a group is permanent and cannot be undone. Set only after stating the exact group to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_pm_user
Destructive
Permanently deletes a user by id in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact user with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | The user's id to delete. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a user is permanent and cannot be undone. Set only after stating the exact user to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
delete_user_role
Destructive
Permanently deletes a user role by id in Aprimo Marketing Operations. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact role with the user. Alternatively, identify the role by name instead of roleId. Note: resolving by name scans the full role list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
roleId | string | No | The role's id to delete. Provide either roleId or name, not both. |
name | string | No | The role's name. Provide either roleId or name, not both. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a user role is permanent and cannot be undone. Set only after stating the exact role to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
reset_user_pin
Destructive
Permanently resets a user's pin in Aprimo Marketing Operations, invalidating their existing authentication credential. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact user with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | The user's integer id whose pin to reset. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — resetting a user's pin invalidates their existing credential and cannot be undone. Set only after stating the exact user to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
userId | integer | |
success | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
update_allowed_child_pick_list_options
Not currently available
Updates the allowed child pick list options for a parent pick list item, by the extended attribute's integer ID and the parent pick list item's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated allowed-child list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
eaId | string | Yes | The parent extended attribute's integer ID. |
parentPicklistItemId | string | Yes | The parent pick list item's integer ID. |
body | string | Yes | JSON object with the updated allowed-child relationship data (PM wire names, e.g. {"allowed": [1, 2, 3]}). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
listName | string (optional) | The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one). |
description | string (optional) | The list's description, when present. |
count | integer | Number of items (precomputed for the llm). |
items | array of SelectionListItemProjection | The list's items. |
items[].itemId | integer | The item's integer value (PM's itemId). |
items[].resourceId | string (optional) | Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it). |
items[].displayValue | string (optional) | Display value identifier. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
items[].systemName | string (optional) | Optional system (code) name for this item. |
items[].color | string (optional) | Optional css color for this item. |
update_pick_list_options
Updates the pick list options for an extended attribute, by the attribute's integer ID, in Aprimo Marketing Operations. Requires confirmed=true after showing the user the exact payload. Returns the updated pick list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
eaId | string | Yes | The extended attribute's integer ID. |
body | string | Yes | JSON object with the updated selection list data (PM wire names, e.g. {"items": [...]}). |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the payload. |
Returns:
| Field | Type | Description |
|---|---|---|
listName | string (optional) | The list's name/identifier, when returned by the wire (named selection lists only -- EA pick-lists and allowed-child-lists don't carry one). |
description | string (optional) | The list's description, when present. |
count | integer | Number of items (precomputed for the llm). |
items | array of SelectionListItemProjection | The list's items. |
items[].itemId | integer | The item's integer value (PM's itemId). |
items[].resourceId | string (optional) | Resource-bundle key for the item's display label -- not human-readable on its own (see ResourceTools' get_resource to resolve it). |
items[].displayValue | string (optional) | Display value identifier. |
items[].sequence | integer (optional) | Sort sequence, when set. |
items[].active | boolean | Whether this item is active. |
items[].systemName | string (optional) | Optional system (code) name for this item. |
items[].color | string (optional) | Optional css color for this item. |
update_pm_group
Updates an existing group by id in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated group. Alternatively, identify the group by name instead of groupId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
groupId | string | No | The group's id. Provide either groupId or name, not both. |
name | string | No | The group's name. Provide either groupId or name, not both. |
body | string | No | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The group's id. String because Groups_GetById/Groups_UpdateItem/Groups_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed GroupProjection.groupId wire field is declared as an ambiguous int32-or-string, same as : kept as a dual-type-tolerant extraction (single confirmed key) rather than a blind strict deserialize. |
name | string (optional) | From the confirmed name wire field (the old guess happened to be right, but was hedging against a PascalCase variant that the hardened schema confirms never occurs). |
raw | object (optional) |
update_pm_user
Updates an existing user by id in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | string | Yes | The user's id. |
body | string | Yes | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string (optional) | The user's id. String because Users_GetById/Users_UpdateItem/Users_DeleteItem declare id as a bare string path parameter (no numeric route constraint) per the snapshot -- but the confirmed UserGroupProjection.userId wire field is declared as an ambiguous int32-or-string ("type": ["integer", "string"], ditto every other id/flag field in this hardened schema): kept as a dual-type-tolerant extraction (single confirmed key, not a casing guess) rather than a blind strict deserialize, since that ambiguity is genuine per the schema itself, not a guess. |
name | string (optional) | Composed from the confirmed firstName/lastName wire fields. UserGroupProjection has no name/userName field at all -- the old code's guess at those key names was wrong; corrected here now that the real field list is known. |
rights | array of UserRightProjection (optional) | /// The PM functional rights this user holds, resolved from the api repo's own UserGroupProjection.Rights (ICollection<UserGroupRightsProjection>) -- confirmed via the PM OpenAPI hardening pass (features/pm-openapi-hardening) that this field is genuinely returned by Users_GetById/Users_GetUser (get_pm_user/get_current_pm_user), just never previously surfaced. Each is the same numbering space as api's UserRightsEnum (e.g. ProgramView = 15) -- the primitive a PM tool-visibility permission check would probe. Null if the raw response predates this field or omits it. |
rights[].functionId | integer | Same numbering space as api's UserRightsEnum (e.g. ProgramView = 15). |
rights[].functionName | string (optional) | |
rights[].domainId | integer | |
raw | object (optional) | The complete wire object, verbatim -- see the class remarks. |
update_user_role
Updates an existing user role by its integer ID in Aprimo Marketing Operations. Only include the fields you intend to change (partial update; omitted fields are left as-is). Requires confirmed=true after showing the user the exact changes. Returns the updated role. Alternatively, identify the role by name instead of roleId. Note: resolving by name scans the full role list.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
roleId | string | No | The role's integer ID. Provide either roleId or name, not both. |
name | string | No | The role's name. Provide either roleId or name, not both. |
body | string | No | JSON object with the fields to change (PM wire names). Omit fields you don't want to modify. |
confirmed | boolean | No | Must be true to proceed. Omit (or false) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly approved the change. |
Returns:
| Field | Type | Description |
|---|---|---|
roleId | integer | |
name | string (optional) | |
description | string (optional) | |
activeFlag | boolean (optional) | |
color | string (optional) | |
currencyCode | integer (optional) | |
usedInAnnotations | boolean (optional) | |
modifiedUserId | integer (optional) | |
modifiedUserName | string (optional) | |
modifiedDate | string (optional) | |
laborRateEntered | number (optional) | Gets or sets the LaborRateEntered. Confirmed against the now-real UserRole component schema (wave-10 field list was incomplete) -- added here, was previously missing entirely. |
laborRateBase | number (optional) | Gets or sets the LaborRateBase. Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |
excludeFromChatboards | boolean (optional) | Flag indicating whether the role excludes its users from the chatboard, wired as a 0/1 int (same convention as /). Confirmed against the now-real UserRole component schema -- added here, was previously missing entirely. |