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.Outcomes
Never report a refused or unknown guest as changed.
Retry safely
On a transport error, retry the confirm with the SAMEclient_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 forRetry-After. See Limits and errors.
Related
- record_signups: sign-ups and statuses on an event with no platform sync.
- get_event_details: read the roster back.
- Connect your CRM and event platform: syncing Luma, Splash or Zuddl.