Grey Label API Documentation
What is Grey Label API Documentation?
Grey Label API Documentation provides White Label partners with a developer documentation experience hosted on a neutral domain. This allows agencies and partners to share API documentation with customers, developers, and integration teams without exposing CRM-specific branding in customer-facing resources.
Key Benefits of Grey Label API Documentation
Using Grey Label API Documentation helps create a more seamless technical experience for customers and external developers. Key advantages include:
- Brand-aligned developer experience: Share API documentation without customer-facing CRM-specific branding.
- Simplified sharing: Provide customers and developers with a direct documentation link that supports White Label use cases.
- Consistent environment alignment: Keep developer documentation consistent with Grey Label and White Label environments.
- Reduced platform branding exposure: Prevent customers from seeing platform-specific references in API documentation.
- Improved integration support: Make it easier for technical teams to access documentation during integration development.
When To Use Grey Label API Documentation
This documentation is best suited for partner-led, customer-facing, or external developer scenarios where a grey-labeled experience is preferred. Use it when:
- Sharing API documentation with customers
- Providing documentation to external developers or integration partners
- Supporting White Label or Grey Label customer environments
- Helping a customer’s technical team review API capabilities
- Reducing platform-specific branding exposure in shared developer resources
For general developer resource navigation, partners may also reference the existing CRM API documentation in the Help Center.
Grey Label Documentation vs. Branded Domain
Grey Label API Documentation and Branded Domain serve different purposes:
- Grey Label API Documentation: Hosted documentation experience used for viewing and sharing grey-labeled API reference materials.
- Branded Domain: Used to customize system-generated links in the CRM platform, such as branded links sent from automated communications.
No DNS or custom domain setup is required to access Grey Label API documentation.
How To Access Grey Label API Documentation
Accessing Grey Label API Documentation does not require any setup process within the CRM platform. Partners can open the documentation link and share it directly with customers, developers, or integration teams as needed.
To access and share the documentation:
- Open the Grey Label API documentation link
- Review the available API documentation based on your integration or development use case
- Share the documentation link with customers, external developers, or integration partners when a grey-labeled experience is preferred
- Use the documentation alongside relevant Help Center resources when building custom integrations or marketplace apps
Always confirm with developers or customers which API areas, authentication methods, scopes, or endpoints they need before beginning implementation.
Frequently Asked Questions
Does this update change existing API functionality?
No. This enhancement focuses on documentation hosting, branding, and reference updates. It does not change existing API functionality.