> For the complete documentation index, see [llms.txt](https://docs.bookline.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bookline.io/partner-api/models.md).

# Models

## The Body\_process\_inbound\_email\_sendgrid\_integrations\_onboarding\_post object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"Body_process_inbound_email_sendgrid_integrations_onboarding_post":{"properties":{"to":{"type":"string","title":"To"},"from":{"type":"string","title":"From"},"subject":{"type":"string","title":"Subject","default":""},"text":{"type":"string","title":"Text","default":""},"html":{"type":"string","title":"Html","default":""}},"type":"object","required":["to","from"],"title":"Body_process_inbound_email_sendgrid_integrations_onboarding_post"}}}}
```

## The ConfirmPaymentRequest object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"ConfirmPaymentRequest":{"properties":{"bookingReference":{"type":"string","title":"Bookingreference"},"bookingToken":{"type":"string","title":"Bookingtoken"},"paymentMethodId":{"type":"string","title":"Paymentmethodid"},"intentType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Intenttype"},"paymentIntentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Paymentintentid"}},"type":"object","required":["bookingReference","bookingToken","paymentMethodId"],"title":"ConfirmPaymentRequest","description":"Payload sent by web-app's /pay/resdiary page (camelCase)."}}}}
```

## The ConfirmPaymentResponse object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"ConfirmPaymentResponse":{"properties":{"status":{"type":"string","title":"Status"},"bookingStatus":{"type":"string","title":"Bookingstatus"},"bookingReference":{"type":"string","title":"Bookingreference"}},"type":"object","required":["status","bookingStatus","bookingReference"],"title":"ConfirmPaymentResponse"}}}}
```

## The CreateTokenRequest object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"CreateTokenRequest":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"grant_type":{"type":"string","title":"Grant Type"},"code":{"type":"string","title":"Code"}},"type":"object","required":["client_id","client_secret","grant_type","code"],"title":"CreateTokenRequest"}}}}
```

## The CreateWhatsappMessageRequest object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"CreateWhatsappMessageRequest":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"destination_phone":{"type":"string","pattern":"^\\+\\d{5,15}$","title":"Destination Phone","description":"Phone number in E164 format"},"message_type":{"type":"string","enum":["booking_created","booking_cancelled","booking_updated"],"title":"Message Type"},"booking_data":{"additionalProperties":true,"type":"object","title":"Booking Data"}},"type":"object","required":["customer_id","destination_phone","message_type","booking_data"],"title":"CreateWhatsappMessageRequest"}}}}
```

## The HTTPValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## The InboundEmailResponse object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"InboundEmailResponse":{"properties":{"status":{"type":"string","title":"Status"},"request_id":{"type":"string","title":"Request Id"},"integration_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Integration Ids"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["status","request_id"],"title":"InboundEmailResponse"}}}}
```

## The IncomingCallData object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"IncomingCallData":{"properties":{"contactPhone":{"type":"string","title":"Contactphone","description":"Phone number in E164 format"},"queue":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Queue"},"mainPhone":{"type":"string","title":"Mainphone","description":"Phone number in E164 format"}},"type":"object","required":["contactPhone","queue","mainPhone"],"title":"IncomingCallData"}}}}
```

## The MessageDataResponse object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"MessageDataResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/WhatsAppMessageStatus"},"created":{"type":"string","format":"date-time","title":"Created"}},"type":"object","required":["id","status","created"],"title":"MessageDataResponse"},"WhatsAppMessageStatus":{"type":"string","enum":["deleted","delivered","failed","read","sent","warning","created"],"title":"WhatsAppMessageStatus","description":"Delivery status of a WhatsApp message.\n\n`CREATED` has been added by us to mark locally-created messages with no\nfeedback status from WhatsApp yet."}}}}
```

## The NewMessageResponse object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"NewMessageResponse":{"properties":{"message_id":{"type":"string","title":"Message Id"}},"type":"object","required":["message_id"],"title":"NewMessageResponse"}}}}
```

## The RevokeTokenRequest object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"RevokeTokenRequest":{"properties":{"client_id":{"type":"string","title":"Client Id"},"client_secret":{"type":"string","title":"Client Secret"},"token":{"type":"string","title":"Token"}},"type":"object","required":["client_id","client_secret","token"],"title":"RevokeTokenRequest"}}}}
```

## The ValidationError object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```

## The WhatsAppMessageStatus object

```json
{"openapi":"3.1.0","info":{"title":"Bookline Partner API","version":"1.11.9"},"components":{"schemas":{"WhatsAppMessageStatus":{"type":"string","enum":["deleted","delivered","failed","read","sent","warning","created"],"title":"WhatsAppMessageStatus","description":"Delivery status of a WhatsApp message.\n\n`CREATED` has been added by us to mark locally-created messages with no\nfeedback status from WhatsApp yet."}}}}
```