arvald

What it can do

The full list of actions an assistant can take, generated from the Arvald API.

An assistant connected to Arvald has 61 actions available. They map directly onto the Arvald API, so anything the list below can do, the API can do, and the same rules apply.

It acts as you. Every action runs with your account's access to your brands. An assistant cannot reach a brand you are not a member of, and asking it to will return a refusal rather than an empty answer.

What it cannot do

Three things are deliberately kept away from assistants:

  • Creating or revoking API keys. A connection that could mint credentials would make a leaked one impossible to shut off properly. Manage keys yourself, in Settings, API keys.
  • Anything on a public booking page. Those endpoints exist for players who are not signed in. An assistant is signed in as you and has better versions of all of them.
  • Anything outside Arvald. It cannot email your players, post anywhere, or touch your payment provider account directly.

The full list

Actions marked asks first move money or destroy something. A well-behaved assistant will confirm with you before running one, and modes and safety explains why that is a strong convention rather than a guarantee.

bookings

arvald_cancel_bookingCancel a bookingasks first
arvald_create_manual_bookingAdd a player to a sessionwrites
arvald_get_bookingRetrieve a booking
arvald_list_bookingsList a brand's bookings. The main way to answer questions about who is booked onto what, and when.
arvald_mark_booking_no_showMark a booking as no-showasks first
arvald_record_booking_paymentRecord an offline paymentwrites
arvald_release_booking_seatRelease one session's seat from a bookingasks first

clients

arvald_archive_clientArchive a clientwrites
arvald_create_clientAdd a clientwrites
arvald_get_clientRetrieve a client
arvald_list_clientsList a brand's clients (the players it coaches). Use this to find a client_id by name.
arvald_restore_clientRestore an archived clientwrites
arvald_update_clientUpdate a clientwrites

locations

arvald_archive_locationArchive a locationwrites
arvald_create_locationCreate a locationwrites
arvald_get_locationRetrieve a location
arvald_list_locationsList locations
arvald_restore_locationRestore an archived locationwrites
arvald_update_locationUpdate a locationwrites

me

arvald_cancel_my_bookingCancel one of your own bookingswrites
arvald_get_meRetrieve your identity
arvald_link_my_clientsClaim the bookings you made as a guestwrites
arvald_list_my_bookingsList your bookings

organizations

arvald_create_organizationCreate a brandwrites
arvald_delete_organizationDelete an organizationasks first
arvald_get_organizationRetrieve an organization
arvald_list_organizationsList your organizations
arvald_update_organizationUpdate an organizationwrites

pages

arvald_create_coach_pageCreate a sub-pagewrites
arvald_delete_coach_pageDelete a sub-pageasks first
arvald_get_coach_pageRetrieve a sub-page
arvald_list_coach_pagesList sub-pages
arvald_update_coach_pageUpdate a sub-pagewrites

payments

arvald_create_payments_account_linkStart payments onboardingwrites
arvald_get_payments_accountRetrieve payments account status

policies

arvald_archive_policyArchive a cancellation policywrites
arvald_create_policyCreate a cancellation policywrites
arvald_get_policyRetrieve a cancellation policy
arvald_list_policiesList cancellation policies
arvald_restore_policyRestore an archived cancellation policywrites
arvald_update_policyUpdate a cancellation policywrites

refunds

arvald_create_refundRefund a booking's payment, in whole or in part. This moves real money in live mode.asks first

sandbox

arvald_reset_sandboxDelete every row in the brand's test-mode sandbox and start it over. Has no effect on live data.asks first

series

arvald_add_series_occurrencesAdd sessions to a serieswrites
arvald_cancel_seriesCancel a seriesasks first
arvald_create_seriesCreate a serieswrites
arvald_get_seriesRetrieve a series
arvald_list_seriesList series
arvald_preview_seriesGenerate a series' dateswrites
arvald_reschedule_seriesApply template changes to a series' sessionswrites
arvald_update_seriesUpdate a serieswrites

services

arvald_create_serviceCreate a servicewrites
arvald_delete_serviceDeactivate a serviceasks first
arvald_get_serviceRetrieve a service
arvald_list_servicesList services
arvald_update_serviceUpdate a servicewrites

sessions

arvald_cancel_sessionCancel a sessionasks first
arvald_create_sessionCreate a sessionwrites
arvald_get_sessionRetrieve a session
arvald_list_sessionsList a brand's scheduled sessions, optionally filtered by series or date range.
arvald_update_sessionUpdate a sessionwrites

Generated from Arvald API contract 0.29.1. This page is built from the same manifest the server runs on, so it cannot drift from what the assistant can actually do.

On this page