Create a new guest

Guests · POST /v1/guests

Create a new guest

POST/v1/guests

Note

Find-or-create: read `created` on the response. With `provider`, the guest is created in that PMS first and `pms.externalId` is its id there; a PMS whose API cannot create guest profiles (Hostaway) is 422 pms_write_unsupported and nothing is created. GET /v1/connect/{provider} → capabilities.pms.guests.create says so beforehand. Guide: /docs/pms-writes#guests

Request

curl -X POST https://api.repull.dev/v1/guests \
  -H "Authorization: Bearer $REPULL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "Marco",
  "lastName": "Rossi",
  "language": "it"
}'

Response

{ "data": { "id": "790", "firstName": "Marco", ... } }

Body Parameters

firstNamestringRequired

lastNamestring

emailstring

phonestring

E.164 preferred. Stored normalised.

languagestring

BCP-47 tag.

currencystring

isBusinessTravelerboolean

providerstring

A connected PMS to create the guest in as well, e.g. `guesty`. Created there first; its id comes back as `pms.externalId`.

Previous← Get Guest NextList Conversations →