Sign in
Orders

Update a guest on an order

Update the details of a guest already attached to an order. Linking the guest to a customer via customer_id overwrites the guest's first_name, last_name, name and email with the customer's profile values, and transfers any existing visit intake form submission to that customer.

put/shop/orders/{orderId}/guests/{guestId}

Request body

namestring

The guest's full name. Required if first_name and last_name are not provided.

first_namestring

The guest's first name. Required when the site enforces separate first/last name fields; otherwise required if name is not provided.

last_namestring

The guest's last name. Required when the site enforces separate first/last name fields; otherwise required if name is not provided.

customer_idstring uuid

Identifier of an existing Customer to link this guest to. The customer must belong to the same brand as the order's site; cross-brand links are rejected with 422.

Example request

{
  "name": "Jane Doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "customer_id": "5ed2b95f72823c4f98419f20"
}

Response

The guest was successfully created or updated.

Example response

{
  "data": {
    "id": "5dcb47800000000000000000",
    "checked_in_at": "2025-10-01T12:00:00+00:00",
    "checked_out_at": "2025-10-01T16:30:00+00:00",
    "customer_id": "5f8a1b2c-9d3e-4a5b-8c6d-7e8f9a0b1c2d",
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "intake_form_submission_id": "5dcb47800000000000000010",
    "last_name": "Doe",
    "name": "Jane Doe"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.