LimeLink V2 Guide
This guide walks through the canonical Organization and Project workspace. Use the focused guides for field-level details.
1. Create or Open an Organization
After signing in, create or open an Organization you can access. An Organization is the collaboration and tenant boundary. Its workspace provides:
- Projects
- API credentials
- Members
- Organization settings
Only resources belonging to the Organization are shown. In a blocked Organization, ordinary mutations are disabled, but an active MEMBER or ADMIN may still leave and an OWNER may still request Organization deletion. The backend remains authoritative for last-OWNER and dependency conflicts.
2. Create or Open a Project
From Projects, create a Project with a unique name, optional logo, and optional default hookup message, or open an existing Project. A Project begins at Links and has its own Appearance, Applications, Custom domains, Billing, and settings.
See Project Management.
3. Configure Appearance
Open Appearance to edit the Project's default hookup message and Skin theme used by landing pages. The default hookup message belongs to the Project; Skin saves only theme configuration.
See Appearance.
4. Add Applications
Open Applications to add the iOS and Android app records needed by mobile routing. You may create multiple Applications for each platform.
5. Create a Default-Domain Link
Open Links, select Create Link, and choose the LimeLink default domain. Enter the Link name, destination URL, and optional suffix. Configure Apple, Android, preview, UTM, and stats options only when needed.
Default-domain Link creation is available on Free. See Create Link.
6. Add a Custom Domain
Open Custom domains and enter only an exact non-apex hostname such as go.example.com, without a protocol or path. The server normalizes lowercase, trailing dots, and IDNA, and remains authoritative for validation and availability. Follow the displayed DNS and certificate lifecycle guidance after creation.
Only an active Pro Project can create a new Custom Domain or a new Custom Domain Link. Existing resources remain visible according to backend policy.
Pro adds Custom Domains for USD $10/month or USD $100/year. Yearly saves $20, equal to two monthly payments. Other core capabilities remain available on Free.
7. Manage Billing
Open Billing to review the Project's current subscription and payment history.
- Free Projects can subscribe to Pro.
- Active Projects can schedule cancellation for period end.
- A scheduled active cancellation offers Keep Pro.
- Cancelled or expired Projects can Subscribe again through a new checkout.
- Past-due, paused, trialing, and unknown states provide guidance instead of unsafe billing actions.
8. Create an API Credential
Open Organization API credentials and select the least-privilege Read and Write scopes needed for Projects, Applications, Custom Domains, and Links. A new secret is shown only once; store it in a server-side secret manager and never ship it in browser or mobile code.
See API Integration for authentication and workflows. Use the Swagger API reference or OpenAPI JSON for exact operation schemas. Native and cross-platform SDKs use the public Project UUID shown in Project settings instead of this Organization secret.
9. Manage Access and Settings
Use Members for role-specific access management:
- MEMBER can view members and leave.
- ADMIN can rename the Organization, invite or remove MEMBER accounts, and leave.
- OWNER can manage roles, members, invitations, and Organization deletion.
Use Organization settings for permitted Organization changes and Project settings for the selected Project. Canonical routes and responses are ancestry-checked to prevent cross-Organization rendering.
Troubleshooting
- Refresh after a retryable loading or unavailable state.
- Check Organization blocked status if mutation controls are disabled.
- Wait for a Custom Domain to become Active before creating a Link on it.
- Treat the server response as authoritative if availability or billing state changes during submission.