Regulars

Interact with the Regulars public API

Actions20

Card Page Actions
- Get Many
- Create Links
Guest Card Actions
- Create
- Bulk Create
Guest Actions
Point of Interaction Actions
Marketing Actions
- Add Voucher
- Send Push

Guest → Update

AI-generated

Summary

Update a guest's information by specifying the Card Page ID, Card ID, and optional JSON fields to modify the guest's profile, card data delta, or card data set.

Inputs

Card Page ID — The ID of the card page associated with the guest being updated.
Card ID (required) — The unique identifier of the guest card to update.
Profile JSON — Optional JSON string representing guest profile data updates.
Card Data Delta JSON — Optional JSON string representing delta updates to guest card data.
Card Data Set JSON — Optional JSON string to set guest card data fields to specific values.

Output shape

a list of updated guest records returned as JSON objects, each in a separate output item

The operation sends a PATCH request to update the specified guest and returns the API's response normalized into items. Multiple input items result in multiple update requests executed sequentially, with their responses concatenated as output.

Examples

Example 1: Update guest with new profile details

Provide the Card Page ID and Card ID of the guest to update, and supply the Profile JSON field with a JSON string containing profile updates.

RegularsInstall