mailerpress-pro/update-custom-field updates an existing contact custom-field definition.
It is identified by field_key; MailerPress also accepts an id in the body for extra safety.
At a glance
| Ability | mailerpress-pro/update-custom-field |
| Toolset | MailerPress Pro — toolset/mailerpress-pro |
| Group | MailerPress Pro › Contact Custom Fields |
| Requires | AcrossAI Pro, plus MailerPress with its Pro add-on active on the site |
| Capability | manage_options |
| Safety | Writes data |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Pro 0.9.16 and later |
How it works
Addressing by key rather than by ID is the right default here, because the key is what everything else in the system uses — a segment condition, a personalisation token, a contact write.
Passing the ID as well is belt and braces: it catches the case where the key you have is stale.
What is safe to change is presentation. The label appears in the admin and in forms, and changing it affects nothing stored.
What is not safe is the type. Stored values are not converted, so a field changed from text to number holds text values that the new type cannot compare — which shows up as segment conditions that stop matching rather than as an error.
The options list on a select-type field is worth care too: removing an option does not remove it from the contacts already holding that value, so a contact can hold a value the field no longer offers.
Idempotent.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
field_key | string | Yes | The field to update. |
id | integer | No | The field ID, as an additional check. |
label | string | No | A new label. Safe to change. |
type | string | No | A new type. Stored values are not converted. |
options | array | No | Replacement options. |
What comes back
| Name | Type | What it is |
|---|---|---|
field | object | The definition after the write. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
Rename the plan-tier field label.
It resolves to one call:
{
"ability": "mailerpress-pro/update-custom-field",
"parameters": {
"field_key": "plan_tier",
"label": "Subscription tier"
}
}Worth knowing
- The label is safe to change; the type is not.
- Stored values are never converted on a type change.
- Removing an option leaves contacts holding it.
- Idempotent.
Related abilities
- MailerPress Pro List Custom Fields — read the definition first
- MailerPress Pro Delete Custom Field — remove it entirely
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category