Accessing API Documentation

Please visit the "category for developers" to view our API documentation. Don't forget to "generate an API key", without which you cannot make any API calls.

• Navigation Menu: The left sidebar provides easy access to different documentation sections, including Introduction, Available SDKs, Configuration, Lists, Fields, Segments, Domains, Subscribers, Email campaigns, and more. You can use this menu to jump to specific topics quickly.

• Language Selection: The top-right corner offers tabs for Shell, PHP, Python, and Ruby. Users can switch between these to view code examples in their preferred programming language.

• Search Functionality: A search bar at the top of the sidebar allows users to find specific information within the documentation quickly.

• External Links: The sidebar includes links to sign up for an API key and to visit the Deploia site, facilitating easy access to related resources.

To make the most of this documentation:

• Familiarize yourself with the overall structure using the navigation menu.

• Use the language tabs to view examples in your preferred programming language.

• Pay close attention to the HTTP Methods and Authorization sections for basic API usage.

• Refer to specific sections as needed when implementing different features of the API.

• Use the search function to quickly locate information on particular topics or endpoints.

• Check back regularly for updates, especially regarding new SDK developments.