Best practices

Best Practices for Duve Open API

  • Use Case: Integrating guest communication features into a hotel’s existing systems
  • API Endpoint: GET /openapi/v1/reservations/links
  • Best Practice: Utilize this endpoint to fetch guest app links and chat links, enabling seamless integration of Duve’s guest communication features into your hotel’s existing systems or mobile apps

Multi-Account Management

  • Use Case: Managing multiple hotel properties or vacation rental accounts through a single API integration
  • API Endpoint: GET /openapi/v1/accounts
  • Best Practice: Use this endpoint to retrieve and manage information for multiple connected accounts, allowing for efficient centralized management of various properties or brands

Secure Authentication and Token Management

  • Use Case: Implementing secure access to Duve’s API across multiple systems or applications
  • API Endpoint: POST /openapi/v1/oauth2/token
  • Best Practice: Implement the OAuth2 flow for secure authentication, and utilize token persistence and renewal strategies to optimize API usage and prevent rate limiting These use cases demonstrate the versatility and power of the Duve Open API, showcasing its ability to enhance guest communication, streamline multi-property management, and ensure secure, efficient API access.

Deactivate and Activate a Property

Manage the status of a property in Duve using API calls to deactivate or activate a property as needed. This guide outlines the required steps and requests to update a property’s status.

Deactivating a Property

Before deactivating a property, ensure the following:

  • Account for Current and Future Stays: Prevent disruptions to the guest experience. Note that related automation will cease to function once the property is deactivated.
  • Disconnect Channel Integrations: Ensure the property is disconnected from all integrated channels.

Endpoint

  • Method: PUT
  • Endpoint: /properties/{id}

Key Parameters

ParameterTypeDescriptionRequired
idstringThe property’s unique ID in Duve.Yes
updateSubUnitsbooleanApply changes to sub-units in a multi-unit.No
Notes

Ensure the Authorization header contains a valid access token. The Reservation ID should be included if applicable to automation. For detailed error handling, refer to the Error Codes Documentation.

Use cases

alt text
alt text
alt text

Troubleshooting API Error Codes

When working with Duve’s API, you might encounter error responses. Understanding HTTP status codes is essential for debugging and resolving issues effectively. This guide highlights the most common client-side (4XX) and server-side (5XX) errors you may face and how to address them. For more information check our Error manual

Contacting Support

If you encounter an unexpected error, and you’ve confirmed your resources, credentials, and access token are valid, please contact our Customer Solutions team with the following details:

  • Full URL of your request.
  • Error code and any accompanying messages.
  • x-request-id value from the response header. This information will help our team assist you more effectively.

Contact Integrations@duve.com

Built with