Documentation Update: This is a non-breaking release that enhances developer experience through better examples and clearer descriptions.
Schema Examples Added
Fleet Schema Examples
Fleet Schema Examples
Added realistic example data for
FleetRead schema showing all available fields:Invitation Schema Examples
Invitation Schema Examples
Added comprehensive examples for invitation workflows:InvitationCreate:InvitationRead:InvitationAccept:
Partner & TSP Examples
Partner & TSP Examples
Added examples for partner and TSP schemas:PartnerRead:TspRead:
Documentation Improvements
Invitation Expiration Extended
Invitation Expiration Extended
Updated Field:
InvitationCreate.expires_in_hoursBefore:- Maximum: 168 hours (7 days)
- Description: “How long the invitation link remains valid (1-168 hours)”
- Maximum: 672 hours (28 days)
- Description: “How long the invitation link remains valid (1-672 hours). Default is 24 hours. Consider longer durations for email campaigns.”
Callback URL Documentation
Callback URL Documentation
Added Field:
InvitationRead.callback_urlPreviously undocumented in the read schema, now explicitly shown:- Type: URL (HTTPS required)
- Description: “Your webhook endpoint to receive real-time notifications for invitation acceptance, share agreement creation, and connection status updates”
Summary
This release enhances the developer experience by:- Adding realistic examples to 7 major schemas
- Extending invitation expiration to 28 days
- Clarifying share agreement status values
- Documenting callback URL field
Need Help?
API Reference
View complete endpoint documentation with current API structure
Contact Support
Questions about migrating your integration? Our team is here to help