Skip to main content
Writes to your event platform and to your heyBTW workspace on action: "confirm": it changes the registration status of guests already on a synced Luma or Splash event, the same change the heyBTW dashboard makes. A preview changes nothing. It never adds a guest. heyBTW sends nothing to a guest, but the event platform may notify a guest of a change, per its own event settings.
Reach for it when the user wants to approve, decline or otherwise change a guest’s status on an event synced to its platform. For an event that is not synced, record_signups changes the status in heyBTW’s record. Follows the heyBTW MCP rules.

When to use it

  • “Approve Maya Chen and Sam Ortiz for the SF dinner.”
  • “Diego can’t make it. Decline him on Luma.”
  • “Move the three people on the waitlist to approved.”

Parameters

Workflow

1

Preview

action: "preview" with the channel_id, status and guests. Nothing changes. data[0].guests answers per guest, in the order named: the roster person matched, current_status, requested_status, platform_value (what the platform receives, or null when the platform does not take that status and only heyBTW’s record changes) and the outcome a confirm would have. data[0].outcome_facts says what each outcome means. The preview carries a preview_token when at least one guest would change.
2

Show the preview to the user

Name each guest, the current and requested status, and what reaches the platform. Wait for the user’s yes. A yes given before the preview does not count.
3

Confirm

action: "confirm" with the SAME channel_id, status and guests, that preview_token and a fresh client_request_id. Per guest the platform is changed first, and heyBTW’s record only after the platform accepts.
A confirm whose guests moved since the preview, or whose preview expired or was already confirmed, is refused: preview again.

Outcomes

Never report a refused or unknown guest as changed.

Retry safely

On a transport error, retry the confirm with the SAME client_request_id. A confirm that ran is replayed (idempotent_replay: true), never repeated.

Errors

  • invalid_parameter: the collab has no event platform, is a Zuddl collab or is archived (the error says which), or the status is not one listed above (the error names the accepted ones). Nothing changes.
  • entity_not_found: a partner’s collab, the demo collab or an unknown id.
  • insufficient_scope: the sign-in lacks write access. Nothing changes. Reconnect and approve write access on the consent screen.
  • rate_limit_exceeded: wait for Retry-After. See Limits and errors.
One collab and at most 100 guests per call. Writing needs no plan: every workspace can write.