Skip to main content

Guests

Guest records and their contact details.

4 endpoints. Every request needs an Authorization: Bearer mtro_... header, and responses follow the envelope described in Errors and conventions.

POST /guests/delete​

Delete a guest profile. This action cannot be undone.

Required scope: any valid API key for the entity.
MCP tool: guests_delete

Request body

FieldTypeRequiredDescription
guestIdstringyesThe guest ID to delete

Example

curl -X POST 'https://core.mtro.app/guests/delete' \
-H 'Authorization: Bearer mtro_your_api_key' \
-H 'Content-Type: application/json' \
-d '{"guestId":"<guestId>"}'

POST /guests/edit​

Update a guest's profile information.

Required scope: any valid API key for the entity.
MCP tool: guests_update

Request body

FieldTypeRequiredDescription
guestIdstringyesThe guest ID to update
namestringyesFirst name. Core requires it on every update, so send the current value when it is unchanged.
surnamestringyesSurname. Core requires it on every update, so send the current value when it is unchanged.
emailstringyesEmail address. Core requires it on every update, so send the current value when it is unchanged.
mobilestringnoUpdated mobile number
birthdaynumbernoUpdated birthday (timestamp ms)
countrystringnoUpdated country

Example

curl -X POST 'https://core.mtro.app/guests/edit' \
-H 'Authorization: Bearer mtro_your_api_key' \
-H 'Content-Type: application/json' \
-d '{"guestId":"<guestId>","name":"<name>","surname":"<surname>","email":"<email>"}'

POST /guests/register​

Create a new guest profile. Required: email, name, surname, password. The password must contain at least 8 characters with an uppercase letter, a lowercase letter, a number, and a special character.

Required scope: any valid API key for the entity.
MCP tool: guests_create

Request body

FieldTypeRequiredDescription
emailstringyesGuest email address
namestringyesGuest first name
surnamestringyesGuest last name
passwordstringyesInitial account password. At least 8 characters with uppercase, lowercase, a number, and a special character.
mobilestringnoGuest mobile number
birthdaynumbernoBirthday as millisecond timestamp
countrystringnoGuest country
sourcestringnoSource of the guest (e.g. LANDING_PAGE, MANUAL)

Example

curl -X POST 'https://core.mtro.app/guests/register' \
-H 'Authorization: Bearer mtro_your_api_key' \
-H 'Content-Type: application/json' \
-d '{"email":"<email>","name":"<name>","surname":"<surname>","password":"<password>"}'

POST /guests/search​

Search for guests by name, email, or other criteria. Returns matching guest profiles.

Required scope: any valid API key for the entity.
MCP tool: guests_search

Request body

FieldTypeRequiredDescription
searchstringnoSearch term matched against guest name, surname, and email. Omit to list every guest.

Example

curl -X POST 'https://core.mtro.app/guests/search' \
-H 'Authorization: Bearer mtro_your_api_key' \
-H 'Content-Type: application/json' \
-d '{}'