Skip to main content

REST API — Account Wall Name

The account wall-name endpoint lets a subscriber set or clear the name shown on community surfaces — the Supporter Wall and [benecaster_member_thanks] output. The change is self-service: a subscriber can only update their own wall name.

Subscribers do not call this endpoint themselves — they use a form. The wall name field on the subscriber account page ([benecaster_account]) is what posts here, so setting a wall name is a normal UI action with nothing to configure. This page documents the endpoint behind that field, for building an alternative account UI or scripting the change.

There is no site-wide setting for this, and no administrator path. A wall name is per-subscriber user meta rather than a plugin option, and the endpoint accepts a write only from the subscriber it belongs to — an administrator cannot set somebody’s wall name through it. What is a setting is whether the Supporter Wall is enabled on a show, which is what makes the field appear.

Base URL: /wp-json/benecaster/v1/account/wall-name


POST /benecaster/v1/account/wall-name

Saves the subscriber’s wall name. The value is stored in _benecaster_wall_display_name user meta on the authenticated user’s account.

Authentication: Cookie auth (nonce). The request must be made by the subscriber whose name is being set — no administrator override path exists on this endpoint.

Rate limiting: Requests are tracked under the account_wall_name bucket.

Request body (application/json):

{
  "wall_name": "Jane Okafor"
}
Field Type Required Description
wall_name string Yes The name to display on community surfaces. Pass an empty string to clear the wall name — the resolution chain will then fall back to first/last name or WordPress display name

Response — 200 OK:

{
  "wall_name": "Jane Okafor"
}

The response echoes the saved value. An empty string in the response means the wall name was cleared successfully.

Error responses:

Status When
400 Bad Request wall_name field is missing or not a string
401 Unauthorized No valid authentication credentials
500 Internal Server Error User meta write failed

Behavior

Setting a name: The submitted value is stored as-is (after sanitisation) in _benecaster_wall_display_name. It appears immediately on the Supporter Wall and in [benecaster_member_thanks] output — no cache flush is required from the caller.

Clearing a name: Passing an empty string deletes the _benecaster_wall_display_name meta entry. benecaster_resolve_wall_display_name() then falls back to first + last name, then to wp_users.display_name.

No effect on the WordPress account: This endpoint writes only to _benecaster_wall_display_name. It does not touch wp_users.display_name or any other WordPress user field.

The field is show-gated on the account page. The wall name input only appears in the [benecaster_account] shortcode when the Supporter Wall is enabled on at least one of the subscriber’s active shows. The endpoint itself has no show gate — it will accept a write regardless of Supporter Wall status.


If you are calling POST /account/display-name

That path does not exist; this endpoint replaces it. It writes to _benecaster_wall_display_name rather than wp_users.display_name, so code calling the old path needs both the new URL and the wall_name field name. The internal rate-limit bucket is account_wall_name.


See Also

Need this built rather than just documented? See our services →