Mask Guests

This endpoint allows you to mask appointment guests.

Experimental: This endpoint exists in the controller but is marked TODO in the service implementation. The request/response may change.

🔹 Endpoint Details

PUT /api/v2/appointments/{id}/mask-guests

🔒 Authentication

Header	Required	Description
Content-Type	Yes	Must be application/json
Authorization	Yes	Format: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature

📝 Request Structure

Path Parameters

Parameter	Type	Required	Description	Example
id	string	Yes	A valid appointment ID.	123e4567-e89b-12d3-a456-426614174000

Body Fields

Field	Type	Required	Description	Example
guests	array	Yes	Guests to mask.	[]
guests[].email	string	No	A valid guest email.	[email protected]
guests[].newEmail	string	No	A valid new guest email.	[email protected]
guests[].phone	string	No	A valid guest phone.	+1565478547
guests[].newPhone	string	No	A valid new guest phone.	+24598883755

🧩 Request Examples

curl -X PUT "https://openapi.onlive.site/api/v2/appointments/1610c525-f19a-40d0-8cd1-03daba3d2d98/mask-guests" \
-H "Content-Type: application/json" \
-H "Authorization: ONLIVESITE Credential:ONLIVEAccessKeyId, Signature=CalculatedSignature" \
-d '{
  "guests": [
    {
      "email": "[email protected]",
      "newEmail": "[email protected]",
      "phone": "+1565478547",
      "newPhone": "+24598883755"
    }
  ]
}'

📤 Response Format

Success Response (200 OK)

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": "EXT-123",
  "title": "Product Demo Meeting",
  "description": "Demonstration of new product features to the client",
  "startAt": "2025-05-20T14:00:00Z",
  "endAt": "2025-05-20T15:00:00Z",
  "lang": "en-US",
  "calendarIds": ["123e4567-e89b-12d3-a456-426614174000"],
  "serviceId": "123e4567-e89b-12d3-a456-426614174000",
  "cancellationOrigin": "user",
  "status": "pending",
  "createdAt": "2025-05-22T10:30:00Z",
  "updatedAt": "2025-05-22T10:30:00Z",
  "guests": [
    {
      "email": "[email protected]"
    }
  ],
  "extraFields": {
    "area": "Madrid",
    "city": "Alcobendas",
    "street": "Carretera. De Fuencarral, 18",
    "country": "Spain"
  },
  "reminders": [
    {
      "time": 10,
      "unit": "m",
      "direction": "before"
    }
  ],
  "event": {
    "eventId": "123e4567-e89b-12d3-a456-426614174000",
    "iCallUrl": "https://meet.example.com/room/123",
    "room": "Demo Room 1"
  },
  "origin": "web",
  "agentComment": null,
  "organizationId": "bfc5b6b5-1d67-419e-9025-96336f2330c6",
  "cancelledAt": null
}

❌ Error Responses

This endpoint follows the standard error format.

📘 Notes

• The organizationId is automatically set from your authentication credentials.

🔍 Validation Rules

1. Original contacts Validation

   • If email is empty phone must have a value.
   • If phone is empty email must have a value.

2. new contacts Validation

   • If newEmail is empty newPhone must have a value.
   • If newPhone is empty newEmail must have a value.