Integration
Connect Archie and TripWorks
When New Booking fires in Archie, your agent runs Update Customer in TripWorks, or Customer Created in TripWorks to Create a document in Archie. Describe the whole flow and it is built, tested on every scenario and kept running.
What the catalog holds today. Ask for anything missing and your agent reads the API documentation and adds it.
Build solutions, not workarounds.
What do you want Archie and TripWorks to do together?
Ask the assistant
Connect your AI client
Give your AI client this address.
https://mcp.apiant.aiOne connection does both: ask your client to act in an app once, or have it build an automation that keeps running. Any client that takes a remote MCP server. Nothing to install. Create your free account, then sign in once in your browser.
Set it up in your client
Claude Code
Run this in the directory you want to work in.
claude mcp add --transport http -s project apiant-ai https://mcp.apiant.aiStart Claude Code there, approve the server, and sign in in the browser page it opens.
Claude Code guide (opens in a new tab)Claude, web and desktop
Open Customize, then Connectors, then Add custom connector, and paste the address. On Team and Enterprise an owner adds it first.
Setup guide (opens in a new tab)Cursor
Add the address to your MCP configuration as a server URL. Cursor signs you in in your browser.
Setup guide (opens in a new tab)Zed
Open Settings, then AI, then MCP Servers, then Add Server, then Add Remote Server.
Setup guide (opens in a new tab)Codex and the ChatGPT desktop app
Open Settings, then MCP servers, then Add server, and choose Streamable HTTP. From the terminal, Codex takes the address with its own add command and then signs you in.
Setup guide (opens in a new tab)Grok
Open grok.com/connectors, choose New Connector, then Custom, and paste the address. Grok signs you in in your browser.
Setup guide (opens in a new tab)Any other MCP client
Paste the address where the client asks for a remote MCP server URL, and name the server apiant-ai where it lets you. APIANT's skills reach the client over the same connection.
Setup guide (opens in a new tab)Example flows
What Archie and TripWorks can do together
From Archie to TripWorks
When New Booking in Archie
then Update Customer in TripWorks
When New Cart Purchase in Archie
then Add Experience Waiver Config in TripWorks
From TripWorks to Archie
When Customer Created in TripWorks
then Create a document in Archie
When Customer Updated in TripWorks
then Create a document revision in Archie
Starting points drawn from the triggers and actions in the catalog today. Describe the flow you need, at any depth, and your agent builds it and tests every scenario before it ships.
Everything your agent can do with Archie and TripWorks
Triggers and actions 15 triggers · 449 actions
Trigger
New BookingTriggers when a new booking is made in the Archie space.
Trigger
New Cart PurchaseTriggers when a new purchase (day pass, product or event ticket) is made in the Archie space.
Trigger
New Day Pass Check InTriggers when someone checks in to the Archie space.
Trigger
New EventTriggers when a new event is created in the Archie space.
Trigger
New InvoiceTriggers when a new invoice is created in the Archie space.
Trigger
New PaymentTriggers when a new payment is recorded in the Archie space.
Trigger
New SubscriptionTriggers when a new subscription to a plan or product is created in the Archie space.
Trigger
New UserTriggers when a new user is added to the Archie space.
Action
Activate AreaActivate an Area
Action
Activate ChildrenActivate all children of an Area
Action
Activate GroupActivate an archived Group and given members for a Space
Action
Activity schedule for teammatesActivity schedule for teammates of the current user (non-paginated list).
Action
Activity schedule (who is in)Paginated activity schedule for all users in the space.
Action
Add ChildrenAdd children to an Area
Action
Admin check-in a visitCheck in a visit as a space admin. Optional multipart form fields: checkInDate, fieldResults, deviceUUID.
Action
Admin checks out a user from the spaceUpdates a presence log to mark the user as checked out
Action
Archive AreaArchive an Area
Action
Archive Area RevisionArchive an Area Revision
Action
Archive a UserArchives a user in the space. User will not be completely deleted, however it will not be visible in the space
Action
Archive ChildrenArchive children of an Area
Action
Archive Children RevisionsArchive all children revisions of an Area
Action
Archive GroupArchive a Group
Action
Archive Plan VersionArchive a plan revision (version)
Action
Archive Product VersionArchive a revision (version) of a product
Action
Archive Ticket PriceArchive a ticket price revision
Action
Assign an Issue TicketAssign an Issue Ticket for a space
Action
Booking Generate InvoiceBooking Generate Invoice
Action
Booking Send DetailsBooking Send Details
Action
Cancel a document signatureCancel a document signature workflow.
Action
Cancel Booking for a spaceCancel Booking for a space
Action
Cancel check-in for a spaceCancel check-in for a space
Action
Cancel Credit NoteCancel a credit note
Action
Cancel Entity Deposit for a groupCancel Entity Deposit for a group in a space
Action
Cancel Entity Deposit for a spaceCancel Entity Deposit for a space
Action
Cancel Entity Deposit for a userCancel Entity Deposit for a user in a space
Action
Cancel EventCancel an event
Action
Check if signature was requested for an emailReturns whether a document signature was requested for the given email on this document.
Action
Close an Issue TicketClose an Issue Ticket for a space
Action
Create a badgeCreate a badge for a space.
Action
Create a Benefit CategoryCreate a Benefit for a space
Action
Create a custom Activity StatusCreate a custom activity status for a space. Only statuses with type `custom` are accepted.
Action
Create a documentCreate a document for the space. Use multipart form: `type`, `title`, `category`, optional `signatureExpirationDays`, `text` for text documents, or `file` for PDF documents.
Action
Create a document revisionAdd a new revision for a document. Multipart: `text`, `requiresSignature`, optional `file` for file-type documents.
Action
Create a door access configurationCreate a door access configuration (space admin).
Action
Create an Accounting Code for a spaceCreate an Accounting Code for a space
Action
Create a Pipeline StageCreate a Pipeline Stage for a space
Action
Create a Post for Channel for Issue Ticket for a spaceCreate a Post for Channel for Issue Ticket for a space
Action
Create a Tax for a spaceCreate a Tax for a space
Action
Create a UserCreate a new user in the space
Action
Create Check-in for a groupCreate Check-in for a group
Action
Create Check-in for a userCreate Check-in for a user
Action
Create Consumption for a Quota for a spaceCreate Consumption for a Quota for a space
Action
Create Credit NoteCreate a new credit note for space
Action
Create Day Pass VersionCreate a day pass revision
Action
Create InvoiceCreate a new invoice for space
Action
Create leads form for spaceCreate leads form for space
Action
Create Payment Account for a spaceCreate Payment Account for a space
Action
Create Payment MethodCreate a payment method for a space
Action
Create Ticket PriceCreate a ticket price revision
Action
Delete a badgeDelete a badge.
Action
Delete a Building Guide SectionDelete a Building Guide Section for a space
Action
Delete a campusDelete a campus and clear location assignments.
Action
Delete a chargeDelete a charge.
Action
Delete a Coupon for a spaceDelete a Coupon for a space
Action
Delete a custom Activity StatusDelete a custom activity status. Only statuses with type `custom` can be deleted.
Action
Delete a depositDelete a deposit.
Action
Delete a documentSoft-delete a document.
Action
Delete a Door Access Account for a user in a spaceDelete a Door Access Account for a user in a space
Action
Delete a door access configurationDelete a door access configuration (space admin).
Action
Delete an Accounting Code for a spaceDelete an Accounting Code for a space
Action
Delete an AmenityDelete an Amenity for a space
Action
Delete an email templateDelete an email template by UUID (space admin).
Action
Delete an Issue ticket categoryDelete an Issue ticket category for a space
Action
Delete an OpportunityDelete an opportunity for a space
Action
Delete a Note for a GroupDelete a Note for a Group in a Space
Action
Delete a Note for a UserDelete a Note for a User in a Space
Action
Delete a Pipeline StageDelete a Pipeline Stage for a space
Action
Delete a presence logDeletes a specific presence log by UUID
Action
Delete AreaDelete an Area
Action
Delete Area RevisionDelete an Area Revision
Action
Delete a Role for a spaceDelete a Role for a space
Action
Delete a Segment for a spaceDelete a Segment for a space
Action
Delete a space emailRequired Scope | `emails:write`
Action
Delete a Tax for a spaceDelete a Tax for a space
Action
Delete a Visit TypeDelete a Visit Type for a space
Action
Delete ChildrenDelete all children of an Area
Action
Delete Credit NoteDelete credit note
Action
Delete Credit Note LineDelete a credit note line
Action
Delete Day PassDelete a day pass for a space
Action
Delete Day Pass VersionDelete a day pass revision
Action
Delete Event TicketDelete a ticket
Action
Delete group fileRequired Scope | `files:write`
Action
Delete InvoiceDelete Invoice
Action
Delete Invoice LineDelete an Invoice Line
Action
Delete Line from PreviewRemove a line from the invoice preview
Action
Delete Line from Preview (2)Remove a line from the invoice preview
Action
Delete Payment AccountDelete Payment Account
Action
Delete Payment MethodDelete a payment method
Action
Delete PlanDelete a plan
Action
Delete Plan VersionDelete a plan revision (version)
Action
Delete ProductDelete a product
Action
Delete Product VersionDelete a revision (version) of a product
Action
Delete Quota for a spaceDelete Quota for a space
Action
Delete Ticket PriceDelete a ticket price revision
Action
Delete user fileRequired Scope | `files:write`
Action
Disable a Door Access Account for a user in a spaceDisable a Door Access Account for a user in a space
Action
Disconnect a Door Access Account for a user in a spaceDisconnect a Door Access Account for a user in a space
Action
Documents for GroupGet all Documents for a Group
Action
Documents for UserGet all Documents for a User
Action
Duplicate AreaDuplicate an Area
Action
Duplicate Area RevisionDuplicate an Area Revision
Action
Duplicate EventDuplicate an event
Action
Enable a Door Access Account for a user in a spaceEnable a Door Access Account for a user in a space
Action
End an evacuationRequired Scope | `evacuations:write`
Action
End the booking at the next rounded intervalEnd a booking early for a space
Action
Export to CSVGet a download link to a CSV file containing all bookings for a given period for a maximum range of 12 months.
Action
Export to CSV (2)Get a download link to a CSV file containing all events.
Action
Export to CSV (3)Get a download link to a CSV file containing all invoices for a given period for a maximum range of 12 months.
Action
Export to CSV (4)Get a download link to a CSV file containing all payments for a given period for a maximum range of 12 months.
Action
Export to CSV (5)Get a download link to a CSV file containing all subscriptions for a given period for a maximum range of 12 months.
Action
Export to CSV (6)Get a download link to a CSV file containing all users for the given space.
Action
Extend document signature expirationSet a new expiration date for a pending document signature.
Action
Extend the booking with the given durationExtend a booking for a space
Action
File Paginate For SpaceGet paginated files for space.
Action
Get Accounting Codes for a spaceGet all Accounting Codes for a space
Action
Get Accounting ConfigurationsList accounting configurations for a space.
Action
Get Active AreasGet all active Areas for a space
Action
Get Active ChildrenGet all active children of an Area
Action
Get Activity StatusesList custom and built-in activity statuses for a space (built-in names are translated for the current user).
Action
Get all check-ins for a spaceGet all check-ins for a space
Action
Get all Notes for a GroupGet all Notes for a Group in a Space
Action
Get all Notes for a UserGet all Notes for a User in a Space
Action
Get all Printing Accounts for a groupGet all Printing Accounts for a group
Action
Get all Printing Accounts for a spaceGet all Printing Accounts for a space
Action
Get Amenities for a spaceGet all Amenities for a space
Action
Get an email templateGet an email template by key or UUID (space admin).
Action
Get an evacuationRequired Scope | `evacuations:read`
Action
Get AreaGet an Area
Action
Get Area RevisionsGet all Area Revisions for an Area
Action
Get AreasGet all Areas for a space
Action
Get Area StatusReturns the current status of the areas in an Archie space, optionally filtered by area category and entity.
Action
Get AvailabilitiesGet availabilities for an Area
Action
Get Available TimesGet available times for an Area
Action
Get Benefit CategoriesGet all Benefit Categories for a space
Action
Get BenefitsGet all Benefits for a space
Action
Get Booking availabilities for rescheduleGet Booking availabilities for reschedule for a space
Action
Get Booking for a spaceGet Booking for a space
Action
Get BookingsGet a paginated list of bookings in a space using filters and sort options.
Action
Get Building Guide SectionsGet all Building Guide Sections for a space
Action
Get charges for a spaceList all charges for a space.
Action
Get check-ins for a Quota for a spaceGet check-ins for a Quota for a space
Action
Get ChildrenGet all children of an Area
Action
Get Children AvailabilitiesGet availabilities for children of an Area
Action
Get community managerReturns the user designated as community manager for the space, including email.
Action
Get consumptions for a Quota for a spaceGet consumptions for a Quota for a space
Action
Get Coupons for a spaceGet all coupons for a space
Action
Get Credit NoteGet Credit Note for space
Action
Get Credit NotesGet a paginated list of credit notes for space
Action
Get Credit Notes for GroupGet a paginated list of credit notes for group in space
Action
Get Credit Notes for Group (2)Get a paginated list of credit notes for group in space
Action
Get Day PassGet a day pass for a space
Action
Get Day PassesGet all day passes for a space
Action
Get Door Access Accounts for a user in a spaceGet Door Access Accounts for a user in a space
Action
Get Entity Deposits for a groupGet all Entity Deposits for a group in a space
Action
Get Entity Deposits for a spaceGet all Entity Deposits for a space
Action
Get Entity Deposits for a userGet all Entity Deposits for a user in a space
Action
Get Entity InvoicesRetrieve a paginated list of invoices for a specific entity (User or Group) within a space.
Action
Get Entity Invoices (2)Retrieve a paginated list of invoices for a specific entity (User or Group) within a space.
Action
Get EventGet an event for a space
Action
Get EventsGet events for a space
Action
Get Event TicketGet a ticket for an event
Action
Get Event TicketsGet tickets for an event
Action
Get GroupGet a Group by UUID or Slug
Action
Get Group InvoicesGet a paginated list of invoices for a Group in Space
Action
Get Group Payment MethodsGet all payment methods for a group in a space
Action
Get GroupsGet all groups for a space
Action
Get Inactive AreasGet all inactive Areas for a space
Action
Get InvoiceGet Invoice for space
Action
Get InvoicesGet a paginated list of invoices for space
Action
Get Issue Ticket CategoriesGet all issue ticket categories for a space
Action
Get Issue Ticket for a spaceGet all issue ticket for a space
Action
Get Issue Tickets for a spaceGet all issue tickets for a space
Action
Get leads form spaceGet leads form space
Action
Get Multiple AvailabilitiesGet availabilities for multiple Area
Action
Get ongoing evacuationRequired Scope | `evacuations:read`
Action
Get OpportunitiesGet all opportunities for a space
Action
Get Payment Accounts for a spaceGet all Payment Accounts for a space
Action
Get Pipeline Stages for a spaceGet all Pipeline Stages for a space
Action
Get PlanGet a plan for a space
Action
Get PlansGet all plans for a space
Action
Get Plan VersionsGet all plan revisions (versions)
Action
Get Posts for Channel for Issue Ticket for a spaceGet all Posts for Channel for Issue Ticket for a space
Action
Get presence logs for a spaceGet all presence logs for a space
Action
Get PreviewGet invoice preview for an entity in a space
Action
Get Preview (2)Get invoice preview for an entity in a space
Action
Get Preview (3)Get invoice preview for an entity in a space
Action
Get Preview (4)Get invoice preview for an entity in a space
Action
Get ProductGet a product for a space
Action
Get ProductsGet all products for a space
Action
Get Product VersionsGet all revisions (versions) of a product
Action
Get Quota for a spaceGet Quota for a space
Action
Get Quotas for a groupGet all quotas for a group
Action
Get Quotas for a spaceGet all quotas for a space
Action
Get quotas for a subscriptionGet quotas for a subscription for a space
Action
Get Quotas for a userGet all quotas for a user
Action
Get Roles for a spaceGet all roles for a space
Action
Get Segments for a spaceGet all Segments for a space
Action
Get SpacesGet all my spaces
Action
Get Taxes for a spaceGet all taxes for a space
Action
Get Ticket PricesGet ticket price revisions
Action
Get UserGet a user in the space by ID
Action
Get User InvoicesGet a paginated list of invoices for a User in Space
Action
Get User Payment MethodsGet all payment methods for a user in a space
Action
Get Visit TypesGet all visit types for a space
Action
Group Get FilesGet all content files for a group
Action
Group Remove UserRemove a User from a Group
Action
List badgesGet all badges configured for a space.
Action
List campusesList campuses for an organization with assigned locations.
Action
List depositsList deposit definitions for a space.
Action
List documents for a spaceList all documents configured for the space.
Action
List document signatures for a spacePaginated document signatures for the space with optional filters.
Action
List door access configurationsList door access configurations for a space.
Action
List email templatesList email templates for a space (space admin).
Action
List evacuationsPaginated list of evacuations for a space (requires evacuation feature and space admin).
Action
List PaymentsGet a paginated list of payments for the specified Space. Without any query parameters, the service will return the first 40 items.
Action
List PurchasesGet a paginated list of purchases for the specified Space. Without any query parameters, the service will return the first 40 items.
Action
List sent emailsList sent email records for a space (space admin).
Action
List space emailsList configured outbound emails for a space (space admin).
Action
List SubscriptionsGet a paginated list of subscriptions for the specified Space.
Action
List unread popup emailsSent emails shown in the user popup that are not read yet.
Action
List UsersGet a paginated list of users for the specified Space. Without any query parameters, the service will return the first 40 users.
Action
List VisitsGet a paginated list of visits for the specified Space.
Action
Mark all popup emails as readRequired Scope | `emails-sent:write`
Action
Mark user as not safeRequired Scope | `evacuations:write`
Action
Mark user as safeRequired Scope | `evacuations:write`
Action
Move the pipeline stage section up in the listMove the pipeline stage section up in the list by changing the rank
Action
Move the Segment up in the listMove the Segment up in the list by changing the rank
Action
My activity scheduleActivity schedule for the current user only.
Action
Paginate leads forms for spacePaginate leads forms for space
Action
Payments Get Balance For Group in SpaceGet payments balance for group in space.
Action
Payments Get Balance For User in SpaceGet payments balance for user in space.
Action
Preview an email templateRender HTML preview for a template (space admin).
Action
Preview badge HTMLRender a preview of badge HTML from payload dimensions.
Action
Print Credit NotePrint a credit note to PDF
Action
Print InvoicePrint an Invoice into PDF
Action
Publish Area RevisionPublish an Area Revision
Action
Publish Children RevisionsPublish all children revisions of an Area
Action
Publish Day Pass VersionPublish a day pass revision
Action
Publish Plan VersionPublish a plan revision (version)
Action
Publish Product VersionPublish a revision (version) of a product
Action
Publish Ticket PricePublish a ticket price revision
Action
Receive Entity Deposit for a groupReceive Entity Deposit for a group in a space
Action
Receive Entity Deposit for a spaceReceive Entity Deposit for a space
Action
Receive Entity Deposit for a userReceive Entity Deposit for a user in a space
Action
Refund Entity Deposit for a groupRefund Entity Deposit for a group in a space
Action
Refund Entity Deposit for a spaceRefund Entity Deposit for a space
Action
Refund Entity Deposit for a userRefund Entity Deposit for a user in a space
Action
Remove ChildrenRemove children from an Area
Action
Restore Credit Note LineRestore a credit note line
Action
Restore Invoice LineRestore an Invoice Line
Action
Restore Line in PreviewRestore a deleted line in the invoice preview
Action
Restore Line in Preview (2)Restore a deleted line in the invoice preview
Action
Restore PreviewRestore invoice preview to initial values
Action
Restore Preview (2)Restore invoice preview to initial values
Action
Send Credit NoteSend a credit note to the entity
Action
Send document for signatureSend or re-send a document signature request for the current user context.
Action
Send InvoiceSend an Invoice
Action
Set Primary Payment MethodSet a payment method as primary for a space
Action
Start an evacuationRequired Scope | `evacuations:write`
Action
Update a badgeUpdate a badge.
Action
Update a BenefitUpdate a Benefit for a space
Action
Update a Benefit CategoryUpdate a Benefit for a space
Action
Update a custom Activity StatusUpdate a custom activity status. Only statuses with type `custom` can be modified.
Action
Update a door access configurationUpdate a door access configuration (space admin).
Action
Update an Accounting Code for a spaceUpdate an Accounting Code for a space
Action
Update a Note for a GroupUpdate a Note for a Group in a Space
Action
Update a Note for a UserUpdate a Note for a User in a Space
Action
Update a Pipeline StageUpdate a Pipeline Stage for a space
Action
Update a Tax for a spaceUpdate a Tax for a space
Action
Update availability end date for a Quota for a spaceUpdate availability end date for a Quota for a space
Action
Update ChildrenUpdate all children of an Area
Action
Update Day Pass VersionUpdate a day pass revision
Action
Update document metadataUpdate title and signature expiration for a document.
Action
Update leads form for spaceUpdate leads form for space
Action
Update Payment Account for a spaceUpdate Payment Account for a space
Action
Update segments for a subscription for a spaceUpdate segments for a subscription for a space
Action
Update Ticket PriceUpdate a ticket price revision
Action
User Get FilesGet all files for user
Trigger
Customer CreatedTriggers when a new customer is added in TripWorks.
Trigger
Customer UpdatedTriggers when a customer is added or any of the customer's details change.
Trigger
Payment CreatedTriggers when a payment is recorded on a trip.
Trigger
Trip CreatedTriggers when a new trip is booked.
Trigger
Trip ReservedTriggers when a trip reaches the reserved status.
Trigger
Trip UpdatedTriggers when a trip is booked or any of its details change.
Trigger
Waiver SignedTriggers when a guest signs a waiver.
Action
Activate Gift CardMakes a gift card active and sets its expiry from your account's gift card expiration policy: a date that many years ahead, or no expiry if the account does not expire gift cards. The balance is not changed, and the activation is recorded in the card's transaction history.
Action
Add Experience Waiver ConfigAttaches a waiver type to this experience as its next waiver, after the ones already there. Send `waiver_type_id`, the waiver type's internal numeric id. Returns 201 with the new waiver config. An experience can have at most 3 waiver configs and each waiver type can appear once.
Action
Assign Custom Field to ExperienceAsks a custom field on this experience, at the end of its order. Assigning a field that is already assigned changes nothing.
Action
Cancel Experience TimeslotsCancels timeslots and the trip orders booked on them. Choose what to cancel with exactly one of:
Action
Clear Callbot Schedule OverrideEnds the schedule override in force, if any, so the schedule decides again. Clearing when none is in force succeeds and changes nothing. Returns the callbot.
Action
Clear Resource Blackout WindowMakes the resources available again for a window: blackouts inside it are deleted, one that spans it is split in two, and one that overlaps an edge is trimmed. Send `resource_ids` (at most 100, else 422 `too_many_resource_ids`), `start_time` and `end_time`; `note` is optional and recorded as the rea
Action
Clone WidgetCreates a copy of a widget, the same way the Clone button in the widget builder does. The copy has the same type, selection, experiences, defaults and configuration (including custom CSS), its name is the original's name followed by " (Copy)", and it gets its own widget id; usage figures and past wi
Action
Create Experience Timeslot ConfigCreates a schedule and queues the generation of its timeslots for every activity in `experience_ids`. Replies 202 with `config_id`, `queued_experience_cnt`, `request_id` and `timeslot_cnt` (how many timeslots will be created in total), and a `Location` header pointing at the schedule.
Action
Delete BookingRemoves the booking from its trip order, exactly as removing a guest in the back office does. Send no body. Removing the last booking on a trip order cancels the trip order (`trip_order_cancelled` true), except on an e-commerce cart that is still a draft, where the whole trip order is deleted instea
Action
Delete CallbotPermanently deletes a callbot, releases its phone number and removes it from the voice provider. Returns 424 `agent_teardown_failed` and keeps the callbot when the provider could not be cleaned up.
Action
Delete Callbot PronunciationRemoves a word from the list and updates every callbot with the voice provider in the background.
Action
Delete CustomerPermanently deletes a customer. Blocked with 409 `in_use`, which includes the counts of what still references the customer, while the customer has bookings, trips, waivers, credit cards or CRM messages. To combine duplicate customers, use Merge instead of deleting.
Action
Delete Custom FieldPermanently deletes a custom field. Blocked (409) while it has answers on any trip or booking, or is assigned to an experience; the response says how many. Fields that depended on it become always shown.
Action
Delete Custom Field ValuePermanently deletes an answer. The custom field and the trip or booking are untouched.
Action
Delete ExperiencePermanently deletes an experience. Blocked (409) if it still has bookings, so cancel or move those bookings first.
Action
Delete Experience Customer TypePermanently deletes a customer type and its channel mappings. Blocked with 409 `default_type_not_removable` while it is the default, and 409 `type_has_bookings` once any booking uses it; hide it with `is_visible: false` instead.
Action
Delete Experience TimeslotPermanently deletes a timeslot. Blocked with 409 `delete_blocked_has_bookings` while it has bookings: cancel it instead.
Action
Delete Experience Waiver ConfigRemoves a waiver config from this experience. Removing the last one turns off the experience's waiver requirement; see the warning on this resource.
Action
Delete Gift CardPermanently deletes a gift card. Refused while the card's trip is locked.
Action
Delete Knowledge BasePermanently deletes a knowledge base, its stored content, and its copy at the voice/chat provider.
Action
Delete LocationPermanently deletes a location. Blocked with 409 `last_location` if this is the account's only location, or 409 `in_use` if an experience, trip, trip order, card reader or shipment still uses it; the error's `dependencies` object gives those counts. Set `is_live` to false to archive a location inste
Action
Delete Multiple Experience TimeslotsPermanently deletes many timeslots, chosen with `ids` or `filters` exactly as for updating many. A timeslot that has bookings is skipped and counted in `blocked_cnt`; cancel it instead. `dry_run: true` returns `would_apply_cnt` and `blocked_cnt` and deletes nothing. More than 1,000 timeslots is refu
Action
Delete Promo CodePermanently deletes a promo code. Blocked with 409 `redeemed`, where `uses` is the number of redemptions, if the code has already been redeemed on an order. To stop such a code being used, set its `promo_code_status_id` to inactive instead.
Action
Delete ResellerPermanently deletes a reseller. Blocked (409 `in_use`, with the trip and invoice counts) while any trip or invoice still references the reseller; notes and cards on file are not counted.
Action
Delete ResourcePermanently deletes a resource along with its blackouts, past and future. Blocked (409) while a real booking is assigned to it. `blackout_removed_cnt` says how many blackouts went with it.
Action
Delete Resource BlackoutRemoves a blackout; the resource is available again for that window.
Action
Delete Resource UsageRemoves a usage: the guest is no longer assigned to the resource.
Action
Delete RestrictionPermanently deletes a restriction. Every experience requires a restriction, so one that experiences still use is refused with 409 `requires_merge` unless you also send `merge_target_id`; the error's `uses` gives the number of experiences affected. Send `merge_target_id` in the request body, the id o
Action
Delete ReviewPermanently deletes a review. This cannot be undone and the review is not archived; any booking it was linked to is left unchanged.
Action
Delete Trip NotePermanently deletes a trip note.
Action
Delete Trip SourcePermanently deletes a trip source. A built-in source cannot be deleted (409 `read_only`). If trips still use the source, the request is blocked (409 `requires_merge`, with the number of trips in `uses`) unless the body includes `merge_target_id`, the public id of another trip source: those trips are
Action
Delete Waiver TypePermanently deletes a waiver type. Blocked (409 `in_use_delete`) if it has been signed, is used by an activity or is required on a booking; archive it instead. The error includes `dependencies` with the signed, activity and booking counts.
Action
Delete WidgetDeletes a widget. The widget disappears from the list and stops loading on your website (its embed code returns not found); its past widget events are kept and still report the widget's name. This cannot be undone through the API, so to switch a widget off temporarily set `is_active` to `false` inst
Action
Get Audit LogReturns one audit log entry by id, with every field change or event detail it contains.
Action
Get Availability InsightsReturns how each timeslot is selling, with a summary over the selection. The overview above explains every field. Requires the `availability.read` scope; add `reports.read` for the revenue fields.
Action
Get BookingReturns a single booking by id, including `booking_status_id`, the price breakdown (see Money), `customer_id`, `trip_order_id`, `resources` (each assignment with resource name and type, start and end time, duration and note), `custom_fields` and `a
Action
Get Booking Check-in QR CodeThe QR code to print on, or show with, this guest's ticket, as a PNG data URI you can put in an `img` tag, plus the address it encodes (`check_in_url`). Scanning it opens that address, which needs a signed-in user of this account; the address identifies the guest by this id, never by name, so it wor
Action
Get CallbotReturns a single callbot by id with its weekly hours, its knowledge base and team member ids, and any schedule override in force.
Action
Get Callbot PronunciationReturns a single pronunciation by id.
Action
Get Country by CodeReturns a single country by its two-letter ISO 3166-1 alpha-2 code (case-insensitive). Responds 404 when the code is not supported.
Action
Get CustomerReturns a single customer by id.
Action
Get Custom FieldReturns a single custom field by id, with its dropdown `options`, the `experience_ids` it is asked on and any dependency on another field.
Action
Get Custom Field ValueReturns a single custom field answer by id.
Action
Get ExperienceReturns a single experience by id, with its ticket types and images.
Action
Get Experience Customer TypeReturns one customer type of this experience. Returns 404 `mismatched_experience` when it belongs to a different experience.
Action
Get Experience TimeslotReturns one timeslot by id, including the ids of its assigned guides and its ticket types with their booked, held and availability counts (`customer_types`, the same name the activity uses for its ticket types; not part of the list). An id that matches no timeslot returns 404.
Action
Get Experience Timeslot ConfigReturns one schedule by id, with `generation`: for each activity, `state` (`idle`, `running` or `failed`) and `failed_at`. An id that matches no schedule returns 404.
Action
Get Gift CardReturns a single gift card by id, with its balance, status and recipient.
Action
Get Knowledge BaseReturns a single knowledge base by id, including its text content for a `text` knowledge base.
Action
Get Knowledge Base CitationReturns a single knowledge base lookup by id.
Action
Get LocationReturns one location by id. An id that matches no location returns 404.
Action
Get ManifestReturns the guest roster for a day or a range of up to 31 days, in departure order. The overview above explains how an entry is organised, the filters and how to check guests in. Requires both the `manifest.read` and `bookings.read` scopes.
Action
Get Payment Detail ReportOne row per successful payment in the date range, with the trip it was taken against. Amounts are integers in cents.
Action
Get Payout Detail ReportOne row per transaction inside each payout in the date range, with the payout it was paid out in and the trip's confirmation code. Columns starting `payout.` are the payout's own figures, repeated on every row of that payout, so do not add them up across rows; use Payouts for payout totals. Amounts
Action
Get Payouts ReportOne row per payout, the deposits made to your bank account. `gross_amount` is Charges and `net_amount` is the Deposit Amount. Amounts are integers in the smallest currency unit (cents for USD), and `currency` names it; refunds and fees are negative. Use Payout Detail for the transactions inside each
Action
Get Phone CallReturns a single phone call by id, with its transcript and tags.
Action
Get Phone Call TagReturns a single phone call tag by id.
Action
Get Promo CodeReturns a promo code, including the experiences, ticket types and date windows it applies to.
Action
Get Report RunReturns one report run.
Action
Get ResellerReturns a single reseller by id.
Action
Get ResourceReturns a single resource by id.
Action
Get Resource BlackoutReturns a single blackout by id.
Action
Get Resource UsageReturns a single resource usage by id.
Action
Get RestrictionReturns one restriction by id. An id that matches no restriction returns 404.
Action
Get ReviewReturns a single review by its id, including its derived sentiment fields. Responds 404 for an id that does not exist in your account.
Action
Get Sales Detail ReportOne row per trip in the date range. Amounts are integers in cents.
Action
Get Team MemberReturns one team member by id, including the permission groups they belong to. An id that matches no visible team member returns 404.
Action
Get TripReturns a single trip by id with its full tree: `trip_orders` (every activity on the trip, including cancelled ones) and each order's `bookings`, fully detailed. Each booking lists its `addons`. A deleted trip (removed by staff, not a cancellation) is still returned; its `trip_status` is `deleted`.
Action
Get Trip NoteReturns a single trip note by id.
Action
Get Trip Order Detail ReportOne row per booked trip order on a reserved trip in the date range, with its experience and trip. Amounts are integers in cents.
Action
Get Trip PaymentReturns a single payment or refund by id.
Action
Get Trip SourceReturns a single trip source by id.
Action
Get WaiverReturns a single signed waiver by id, with the same fields as the list.
Action
Get Waiver Document LinkReturns a link to the signed PDF of this waiver, valid for five minutes. Each call issues a new link and writes an audit log entry naming the key that asked.
Action
Get Waiver TypeReturns a single waiver type by id, including its waiver text and every signer requirement.
Action
Get WidgetReturns a single widget by the widget id from its embed code. Responds 404 for an id that does not exist in your account, or belongs to a deleted widget.
Action
Get Widget FunnelA conversion funnel over the widget events: how many visitor sessions reached each stage, with the percent of the first stage and of the previous stage. Each stage counts the distinct sessions that fired that event in the period, in any order, so a visitor counts once per stage however many times th
Action
Get Widget LogReturns a single widget event by its id. Responds 404 for an id that does not exist in your account.
Action
List Audit LogReturns audit log entries, newest first, optionally filtered and sorted. The overview above explains what is recorded, how to read an entry and how to filter by record, team member, entry type and date.
Action
List Blackouts of ResourceReturns the blackouts on one resource: the times it is unavailable, earliest first.
Action
List Booking Add-onsReturns the add-ons on this booking (options the guest picked, such as an extra hour or a meal choice), oldest first, each with its `addon_title`: exactly the booking's `addons`. The `total` of every line whose `price_adjust_type_id` is not 2 adds up to the booking's `addons_total`, and `total_gross
Action
List Booking Custom FieldsReturns the booking's custom fields: exactly the entries of the booking's `custom_fields`, `{id, slug, name, type, value, required}` (plus `unit`, `lbs` or `kg`, on Weight fields), for every booking-level custom field that applies to its experience, in back-office order, answered or not (`value` is
Action
List Booking ProductsReturns the products (extras sold with the ticket, such as a photo package or a rental) on this booking, oldest first. It is a full breakdown of the booking's `products_total`: the `total` of every line adds up to `products_total`, and `total_gross` adds up to `products_total_gross`. Amounts are int
Action
List Booking Resource UsagesReturns the resource usages on a booking: the resources (boats, vehicles, guides and so on) this guest is assigned to, earliest first.
Action
List BookingsReturns a paginated list of bookings, newest first (highest `id` first; ids only ever increase, so this is creation order). Filter by `trip_order_id`, `customer_id`, `booking_status_id`, `experience_customer_type_id` and `booking_waiver_status` (a slug). Only these indexed fields can be filtered, an
Action
List Booking StatusesReturns the account's booking statuses in display order. Use an `id` from this list as `booking_status_id` when setting a booking's status or adding a booking. Custom statuses share the slug `user`, so always identify a status by `id`, never by `slug` or `name`.
Action
List Booking WaiversReturns the booking's waiver requirements: exactly the entries of the booking's `waivers`, `{waiver_type_id, name, status, has_signed_waiver, waiver_id}`, one for every waiver requirement of its experience, signed or not. `status` is `signed` or `unsigned` (a requirement with no record is `unsigned`
Action
List Callbot PronunciationsReturns the account's pronunciation list ordered by word, paginated. Filter by `word` or `say`; `?sort=word` and `?sort=-word` change the order.
Action
List CallbotsReturns a paginated list of callbots ordered by name, one flat row each without the weekly hours, the knowledge base and team member ids or the schedule override details. Filter by `name`, `is_active`, `voice_id`, `phone_number`, `twilio_number`, `notification_mode`, `hours_mode`, the `can_*` flags,
Action
List Callbot VoicesReturns the voices a callbot can use: the `id` is the value to send as `voice_id` when creating or updating a callbot. This is a short list returned whole, without pagination or a `meta` block.
Action
List CountriesReturns a paginated list of supported countries, ordered by name. Filter by code, name, three-letter code or dialing code, and sort by `name` or `code`.
Action
List CustomersReturns customers.
Action
List Custom FieldsReturns a paginated list of custom fields in the account-wide order. Filter by `custom_field_map` (`trip` or `booking`), `custom_field_type` slug, `visibility`, `is_required`, `internal_name`, `title`, `parent_custom_field_id`, or by ranges on `sort_order`, `min_value`, `max_value` and `created_at`.
Action
List Custom Field ValuesReturns a paginated list of custom field answers, newest first. Filter by `booking_id` for one guest's answers, `trip_id` for one reservation's, or `custom_field_id` for every answer to one field.
Action
List Experience Customer TypesReturns every customer type of this experience in display order, lowest `sort_order` first. The list is not paginated. Narrow it with the filters below, for example `?is_visible=true` or `?name[contains]=adult`. Customer types with no value for a numeric filter never match it, and `is_group=false` m
Action
List Experience Custom FieldsReturns the custom fields asked on this experience, in the order guests and staff see them. Guests answer trip fields once per reservation and booking fields once per guest.
Action
List ExperiencesReturns a paginated list of experiences, ordered by name unless you pass `sort`. Filter by name, location, status, capacity type and the other settings listed below.
Action
List Experience Timeslot ConfigsReturns a paginated list of schedules in id order unless you pass `sort`. Filter by `id`, `name`, `start_date` and `end_date`. Generation status is only on a single schedule.
Action
List Experience TimeslotsReturns a paginated list of timeslots in id order (creation order), optionally filtered and sorted. Each timeslot carries its `guide_ids`. Filter by `id`, `experience_id`, `status`, `start_time`, `is_anytime`, `schedule_id` and the three visibility flags.
Action
List Experience Waiver ConfigsReturns every waiver config attached to this experience in display order, lowest `sort_order` first. The list is not paginated. A config's `waiver_option_overrides` is left out when it has no value.
Action
List Gift CardsReturns a paginated list of gift cards, newest first unless you pass `sort`. Filter by status, balance, expiry date, trip, code or style.
Action
List Gift Card StylesReturns the gift card styles available to choose from: the value to use for `gift_card_style_id` when creating or updating a gift card. Styles are read-only here; they are managed in the back office.
Action
List Knowledge Base CitationsReturns a paginated list of knowledge base lookups, optionally filtered and sorted.
Action
List Knowledge BasesReturns a paginated list of knowledge bases, optionally filtered and sorted. Text content is only returned when fetching one knowledge base.
Action
List LocationsReturns a paginated list of locations, ordered by name unless you pass `sort`, optionally filtered and sorted. Filter by `id`, `name`, `is_live` or `country_id`.
Action
List Phone CallsReturns phone calls, newest first unless you pass `sort`, optionally filtered and sorted. The overview above explains where calls come from, how to read one and how to filter.
Action
List Phone Call TagsReturns phone call tags, optionally filtered. The overview above explains the tag types and how to filter.
Action
List Promo CodesReturns a page of promo codes, up to 25, ordered by code unless you pass `sort`. Rows leave out `experiences`, `customerTypes` and `promo_code_dates`; Get one includes them. See Finding promo codes above for filter and sort examples.
Action
List Report RunsReturns a paginated list of report runs across all reports, newest first. Filter with `?report_type=sales_detail.1`, `?report_run_status=succeeded|pending|failed` or `?created_at[gte]=`. Sort with `?sort=created_at`.
Action
List Report TypesReturns every report you can run, with the parameters each one takes and every column it can return.
Action
List ResellersReturns a page of resellers, up to 25, ordered by id unless you sort. See Finding resellers above for filter and sort examples.
Action
List Resource BlackoutsReturns a paginated list of blackouts, earliest first by default. Filter by `resource_id` for one resource, or by `start_time`/`end_time` with `[gte]` and `[lte]`. To find blackouts overlapping a window send `end_time[gte]=<window start>&start_time[lte]=<window end>`. Time filters take any RFC 3339
Action
List Resource GroupsReturns the resource groups available to choose from: the value to use for `resource_type_id` when creating or updating a resource.
Action
List Resource IconsReturns the icons available to choose from: the value to use for `resource_icon` when creating or updating a resource.
Action
List ResourcesReturns a paginated list of resources, ordered by name by default. Filter by `name`, by `resource_type_id` for one group, by `resource_icon` slug, by `pax` range, or by `color`.
Action
List Resource UsagesReturns a paginated list of resource usages, earliest first by default. Filter by `booking_id` for one guest, by `resource_id` for one resource, or by `start_time`/`end_time` with `[gte]` and `[lte]`. To find usages overlapping a window send `end_time[gte]=<window start>&start_time[lte]=<window end>
Action
List RestrictionsReturns a paginated list of restrictions, optionally filtered and sorted. The default order applies when `sort` is omitted. Every field can be filtered; the `*_min`, `*_max`, hours and days fields accept `gte` and `lte`, and the names accept `contains` and `begins_with`.
Action
List ReviewsReturns a paginated list of reviews, newest first by default. Filter by `id` (also `[gte]`/`[lte]`), `rating`, `sentiment_positive`, `sentiment_negative` or `sentiment_neutral` (each also `[gte]`/`[lte]`), `is_approved`, `name` or `location` (also `[contains]`/`[begins_with]`), `overall_comment` or
Action
List Team MembersReturns a paginated list of team members in the order they were added unless you pass `sort`, optionally filtered and sorted. TripWorks-managed accounts and accounts linked to a reseller or affiliate are never included. The list leaves out `groups`; get one team member to see their permission groups
Action
List Trip Custom FieldsReturns the trip's own custom fields: `{id, slug, name, type, value, required}` (plus `unit`, `lbs` or `kg`, on Weight fields) for every trip-level custom field asked on any of its activities, in back-office order, answered or not (`value` is null when unanswered). Guest-level fields are on each boo
Action
List Trip NotesReturns a paginated list of trip notes, newest first by default. Filter by `trip_id` to get every note on one trip, by `user_avatar_id` for one author, or by `created_at[gte]`/`created_at[lte]` for a time range.
Action
List Trip PaymentsReturns a paginated list of payments and refunds, newest first by default, including those on draft and deleted trips. Filter by `trip_id` to get every payment on one trip, by `payment_status`, `payment_type_id` or `payment_direction_id`, by `created_at[gte]`/`created_at[lte]` for a time range, or b
Action
List TripsReturns a paginated list of trips ordered by activity date with the latest first (upcoming trips before past ones), then newest created, one flat row per trip with no `trip_orders` or `bookings`. Filter by `confirmation_code`, `trip_status`, `trip_type`, `customer_id`, `trip_source_id`, `reseller_id
Action
List Trip SourcesReturns a page of trip sources, up to 25. See Finding trip sources above for filter and sort examples.
Action
List Usages of ResourceReturns the resource usages on one resource: the guests assigned to it, earliest first.
Action
List WaiversReturns a paginated list of signed waivers, newest signed first, one row per signature. Filter by `waiver_type_id`, `customer_id`, `trip_order_id`, `is_waiver_adult`, a date range on `created_at` (`created_at[gte]`, `created_at[lte]`), a date of birth or range on `dob`, text on `first_name`, `last_n
Action
List Waiver TypesReturns a paginated list of waiver types, ordered by name, optionally filtered and sorted. Every field can be filtered: `name` and `title` with `eq`, `contains` or `begins_with`; `body` and `body_minor` with `contains`; the age limits with `eq`, `gte` or `lte`; the flags and `waiver_type_status` (a
Action
List Widget LogsReturns a paginated list of widget events, newest first by default. With no lower bound on `created_at` the list covers the 30 days up to now, or up to `created_at[lte]` when only that is given; pass `created_at[gte]` to look further back. Filter by `id` (an exact match), `created_at` (also `[gte]`/
Action
List WidgetsReturns a paginated list of widgets, ordered by name. Deleted widgets are never included. Filter by `name` (also `[contains]`/`[begins_with]`), `widget_type`, `selection_type`, `default_view`, `default_language`, `embed_type`, `is_active`, `clicks` or `embeds` (each also `[gte]`/`[lte]`), or `create
Action
Mark Booking Waivers SignedMarks every waiver the booking's experience requires as signed, using the same per-requirement step as `.
Action
Mark One Booking Waiver SignedMarks a single one of the booking's waiver requirements as signed. The requirement is identified by its `waiver_type_id` from the booking's `waivers`. Send no body. This is a staff override: it records that requirement as signed without a signed waiver document
Action
Merge CustomersMerges two or more customers into one and permanently deletes the duplicates. Send at least two customer ids in `ids`. TripWorks chooses the destination: the customer with the most complete name, phone and email, and the oldest record if they tie. Blank phone, country, street address, city, state, p
Action
Reload Gift CardAdds `amount`, a positive whole number of cents, to both the original and the current balance, and sets the card to `pending` until the paying trip settles. Refused for a deleted or expired card.
Action
Reorder Custom FieldMoves the field to a position in the account-wide order (0 is first) and shifts the fields in between. A position past the end puts it last. Returns the field with its new `sort_order`.
Action
Reorder Experience Custom FieldsSets the order the experience's custom fields are asked in. `custom_field_ids` lists assigned field ids in the order you want; fields you leave out keep their relative order after the listed ones.
Action
Reorder Experience Waiver ConfigsSets the display order of this experience's waiver configs. Send `order` as a list that contains the `id` of every waiver config on the experience exactly once, in the order you want. An empty list returns 400. An id that is not a waiver config of this experience, or a list that leaves one out, retu
Action
Set Booking StatusSets the booking's status to any of the account's booking statuses, the same choice the back office offers (for example checked in, no-show, or back to not checked in).
Action
Set Callbot Schedule OverrideStarts a schedule override that beats the schedule, replacing any already in force. `mode` is `answer` (answer every call) or `transfer` (send every call to a person). `duration` is `next_schedule` (until the schedule next changes), `custom` (until `until`, a date and time in the account's timezone,
Action
Set Status for Multiple BookingsSets the status of up to 50 bookings in one call, for example to check in a whole party. Identify the target status by `booking_status_id` or by `status`, the shorthand for a built-in status. Pass `dry_run: true` to see what wo
Action
Sync CallbotQueues another attempt at setting the callbot up with the voice provider, for one whose last sync failed or is stuck. Returns immediately with the status the sync is now in (`sync_status`).
Action
Sync Callbot Prompt from TemplateBrings the callbot up to date with the latest TripWorks callbot template at the voice provider. Returns 409 `template_sync_failed` with a plain-language message when the provider rejects it, and `notice` names any knowledge base documents that were dropped to let it through.
Action
Sync Knowledge BaseQueues a re-sync of the knowledge base to the voice/chat provider. Returns immediately; poll `sync_status` for progress. Blocked (409) for a type that cannot be synced.
Action
Unassign Custom Field from ExperienceStops asking a custom field on this experience. Answers already given are kept. Returns 404 if the field is not assigned to the experience.
Action
Update CallbotUpdates a callbot and queues re-syncing it with the voice provider. Only the fields you include are changed; omitted fields are left as they are. The `schedule_override_*` fields cannot be written here: use the set and clear schedule override actions.
Action
Update Callbot PronunciationChanges a word or its respelling and updates every callbot with the voice provider in the background. Only the fields you include are changed.
Action
Update CustomerUpdates a customer and returns it. Only the fields you include are changed; omitted fields are left as they are. Write `sms_paused: false` to let texts go to the customer's number again after the carrier reported it cannot receive them; it is refused (422) for a customer who opted out, which only th
Action
Update Custom FieldUpdates a custom field. Only the fields you include are changed. `custom_field_type` and `custom_field_map` cannot be changed: sending the value the field already has is accepted, anything else is rejected with 422. When you send `options` or `experience_ids` the list you send replaces the current o
Action
Update Custom Field ValueChanges the answer. `value` is the only field that can be changed; the custom field and the trip or booking are fixed. Send `null` to empty the answer.
Action
Update ExperienceUpdates an experience. Only the fields you include are changed; omitted fields are left as they are. The status, ticket types and images cannot be changed here; ticket types are managed at `/rest/experiences/{id}/customer-types`, except which one is the default: set `default_customer_type_id` here.
Action
Update Experience Customer TypeChanges a customer type. Only the fields you include are changed. `is_default` cannot be written here: set `default_customer_type_id` on the experience to change the default. `null` clears `description`, `pax_fixed`, `pax_min`, `pax_max`, `deposit_amount` and `deposit_percent`. `capacity` is only ac
Action
Update Experience TimeslotUpdates a timeslot. Only the fields you include are changed, and the change is all or nothing: if any field is refused, none is applied.
Action
Update Experience Waiver ConfigChanges which waiver type a config uses with `waiver_type_id`, who signs it for each ticket type with `waiver_option_overrides`, or both. Only the fields you include are changed. Send `waiver_option_overrides` as `null` to clear the overrides. Each override value must be 1 (Adult), 2 (Minor) or 3 (C
Action
Update Gift CardUpdates a gift card. Only the fields you include are changed; omitted fields are left as they are. `trip_id` cannot be changed after creation, and the balance and status cannot be written.
Action
Update Knowledge BaseUpdates a knowledge base and queues a re-sync. Only the fields you include are changed — omitted fields are left as-is. The type cannot be changed (409).
Action
Update LocationUpdates a location. Only the fields you include are changed — omitted fields are left as-is.
Action
Update Multiple Experience TimeslotsMakes the same change to many timeslots: the same fields and the same decisions as updating one. Choose them with `ids`, or with `filters`. Add `dry_run: true` to see what would happe
Action
Update Promo CodeUpdates a promo code and returns it. Only the fields you include are changed; omitted fields are left as they are. The experiences and ticket types of a code cannot be changed: `experience_ids` and `customer_type_ids` are accepted on Create only, and sending them here is rejected with 422 `unknown_f
Action
Update ResellerUpdates a reseller. Only the fields you include are changed — omitted fields are left as-is. The reseller type is set at creation and cannot be changed: sending `reseller_type_id` is rejected with 422 `unknown_fields`, as is any other field that is not writable (including `collect_type` and `commiss
Action
Update ResourceUpdates a resource. Only the fields you include are changed; omitted fields are left as they are. `resource_type_id` can be null to remove the resource from its group.
Action
Update Resource BlackoutChanges the note of a blackout; `note` is the only field that can be changed, and null clears it. To change the times, clear the window and create a new blackout.
Action
Update Resource UsageChanges a usage in one atomic write. Only the fields you include are changed. `resource_id` moves the guest to another resource, `start_time` and `end_time` or `duration` change the window (without `end_time` or `duration` the length is kept), and `internal_note` sets or clears the staff note. The b
Action
Update RestrictionUpdates a restriction. Only the fields you include are changed; omitted fields are left as they are. The change applies to every experience that uses the restriction.
Action
Update ReviewPartially updates a review. Only the fields you include are changed — omitted fields are left as-is, and an explicit `null` clears nullable fields such as `location` and `experience_id` (comments are cleared and then omitted from responses; `name`, `rating` and `review_type` cannot be cleared). Chan
Action
Update Team MemberUpdates a team member's profile. Only the fields you include are changed. `email` and `cell_phone` are read only, and login passwords and permission-group assignment cannot be changed through the API. A failed validation returns 422 with an `errors` object keyed by field.
Action
Update Trip NoteChanges the text of a note and marks it as edited. `text` is the only field that can be changed after creation; the trip and author are fixed.
Action
Update Trip PaymentChanges the note and the details of the payment's own type: `notes` for any payment, `check_number` and `check_date` together for a check, `wire_date` for a wire, `voucher_number` for a voucher. Send `notes` on its own, not with a detail field (refused even as `null` or an empty string); alone, `nul
Action
Update Trip SourceUpdates a trip source and returns it. Only the fields you include are changed; omitted fields are left as they are. On a built-in source, a new `name` is ignored. `is_read_only` and `category_slug` cannot be set: sending either is rejected with 422 `unknown_fields`.
Action
Update Waiver TypeUpdates a waiver type. Only the fields you include are changed; omitted fields are left as-is. Setting `waiver_type_status` to `archived` is refused with 409 `in_use_archive` while an activity uses the waiver type. Sending `waiver_type_status: null` is rejected with 422; the status cannot be cleared
Action
Update WidgetPartially updates a widget: only the fields you include are changed. Writable fields are `name`, `widget_type`, `selection_type`, `experience_ids` (the full list, as ids from `/rest/experiences`; it replaces the existing list), `default_view`, `default_language`, `embed_type`, `is_active` and `custo
No trigger or action matches that. Ask your agent to add it: it reads the API documentation and builds what you describe.
Each app on its own
Reviews
What our customers say
More from Archie
Archie to HubSpotHubSpot is your all-in-one stop for all of your marketing software needs.
Archie to SalesforceSalesforce is a leading enterprise customer relationship management (CRM) platform.
Archie to SlackSlack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...
Archie to Google SheetsGoogle Sheets is Google's online spreadsheet app for creating, editing and sharing spreadsheets.
Archie to GmailGmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...
Archie to Google CalendarGoogle Calendar is a time management tool providing scheduling features, event reminders, and integration...
More into TripWorks
HubSpot to TripWorksHubSpot is your all-in-one stop for all of your marketing software needs.
Salesforce to TripWorksSalesforce is a leading enterprise customer relationship management (CRM) platform.
Slack to TripWorksSlack is a messaging platform for teams. Post messages, manage channels, users, reminders, and react to...
Google Sheets to TripWorksGoogle Sheets is Google's online spreadsheet app for creating, editing and sharing spreadsheets.
Gmail to TripWorksGmail is Google’s email service, featuring spam protection, search functions, and seamless integration with...
Google Calendar to TripWorksGoogle Calendar is a time management tool providing scheduling features, event reminders, and integration...
Questions
Archie and TripWorks, answered
What can start an automation from Archie?
Any of Archie's 8 triggers in the catalog, including New Booking, New Cart Purchase, New Day Pass Check In and New Event. Describe the moment in plain language and your agent picks the right one.
What can your agent do in TripWorks when something happens in Archie?
Any of TripWorks's 169 actions, including Create Experience Timeslot Config, Update Callbot, Update Callbot Pronunciation and Update Customer. Your agent maps the data both ways and tests every scenario before it ships.
Can it also run from TripWorks to Archie?
Yes. When something happens in TripWorks, your agent can act in Archie too. This page covers both directions: TripWorks's triggers and Archie's actions are listed here as well.
Do I have to build a connector for Archie or TripWorks?
No. Both are in the catalog with their triggers and actions. You describe the automation; your agent builds it, tests every scenario and keeps it running.
Can my AI client use Archie and TripWorks without building an automation?
Yes. With your AI client connected to APIANT, ask it to do something in either app once and it runs that action on the spot. Ask for an automation and your agent builds it, tests every scenario and keeps it running. One connection covers both.
What happens when something fails?
Your agent works that out for you. It plans the failure paths along with the happy path, then tests every scenario before it ships.
Is there a free plan?
Yes. Every plan includes the agent, including free, and building from your own AI client spends no assistant credits.