Changing your API platform

If you're moving to a different API platform, tell us before you switch. Your connection to Headout has to be rebuilt against the new platform, and doing that in advance avoids a gap where bookings fail or availability disappears.

Before you start

• Know which new platform you're moving to.
• Have the Headout Experience ID for every experience affected by the switch.
• Have the new API codes if your platform has already issued them.
• Know the date you're switching over.

Important: Raise this as early as you can, and give us the switchover date. Our automation team needs to rebuild and test the connection — if the old platform is turned off before the new one is connected, bookings can fail and guests are affected.

Step 1 — Open the request form

• Click Help in the left-hand menu of Hub. This signs you into the Help Centre.
• Click Submit a request.
• Choose API and integration related.

Step 2 — Select the issue

Step 3 — Tell us what's changing

You'll be asked for:

• Please enter Headout Experience ID — required. List every experience affected.
• New API Platform — the platform you're migrating to.
• Add API Code for your experience — the new codes, if you have them. Enter them separately against each Experience ID, comma separated.

Use the Description for the switchover plan: the date you're moving, whether the old platform stays live during the transition, and whether all your experiences move at once or in stages. Attach a spreadsheet if there are a lot.

Click Submit. Our automation team will plan the migration with you.

Frequently asked questions

How much notice should I give?
As much as you can. The connection has to be rebuilt and tested against the new platform, so the more warning our automation team has, the less chance of a gap in selling.

I don't have the new codes yet.
Raise the request anyway with the new platform name and the affected Experience IDs, and say the codes are coming. Starting the conversation early is more useful than waiting for complete information.

Should I stop sales during the switch?
If there'll be a window where neither platform is connected, yes — close the affected slots so nothing is sold that can't be fulfilled, and reopen once it's live. See Managing availability and inventory.

What happens to bookings already made?
Existing bookings stand. If any are affected by the switch, raise them under Customer Booking Related so those guests are handled.

Is this the same as updating an API code?
No. Use this when the platform itself changes. If you're staying on the same platform and only the code has changed, see Updating an API code for an existing experience.

My new platform isn't one you support.
Raise the request and name it — our automation team will confirm what's possible and, if a direct connection can't be built, discuss the alternatives with you. See Automated connectivity options.

Something's wrong after the migration.
Report it — see Reporting an API error.