Skip to content
Levr API Documentation
Download OpenAPI specOpenAPI

Hand off to an AI agent

Copy instructions to your AI agent

Copy this guide into your AI agent. It links to the current REST API and MCP documentation.

You are helping someone integrate their system with Levr. Use Levr's published documentation and machine-readable contracts as the source of truth. Do not invent endpoints, fields, or MCP tools.

  1. Start with the Levr API documentation to choose between a server-to-server REST integration and a user-authorized MCP connection.
  2. For REST, read the Markdown REST API guide, choose the user’s task, then fetch only the relevant resource guide and operation Markdown. Resource indexes include task guidance. For funding recommendations, start with the Matchmaking guide. Use the OpenAPI specification for exact paths, authentication, parameters, and envelope schemas.
  3. For REST client intake, Deal applications, or project Criteria, fetch that resource's contract_url. Its Application Contract is the authority for the current questions, stable keys, repeatable groups, file-transfer steps, accepted answer shapes, conditional visibility, supported operation URLs, and integration instructions. Repeatable fields require the returned item_id. File bytes use the expiring upload_url and multipart field named file; they never belong in JSON. Do not substitute a static example or the latest application definition.
  4. For an AI client acting with a signed-in user's access, read the MCP connection instructions in Markdown first, then the Model Context Protocol guide if needed. Let the connected MCP server expose its current tools and input contracts; do not infer tools from the REST API. Read the relevant MCP resource guide and follow the discovered tool’s revision, file-transfer, and confirmation requirements.
  5. Use URLs from the record handoff when supplied; otherwise use this documentation environment. Keep API keys and file-transfer credentials out of browser code, logs, prompts, and source control.
  6. Before implementing a write, verify authentication, required inputs, idempotency, error responses, and retry guidance in the current contract. If an operation is not documented, do not assume it exists.

Early access

Request an integration

Tell us what your integration needs to do. Add an email if you want a reply.

Activate, deactivate, or discard custom domains

Read as Markdown

All MCP tools

management_groups.change_domain_lifecycle

Activate, deactivate, or discard custom domains. Read branding immediately first and pass its revision. An explicit request to complete whitelabelling includes activating the requested addresses when ready. Domain activation affects the Management Group; confirm that shared scope matches the request. Activate checks current DNS and HTTPS and enables a configured, verified sender; an unverified sender stays disabled. Only branding.domain_activation.status=active means activation completed, even when the call succeeds. If waiting, allow retry_after_seconds, read branding again, and retry with a fresh revision and request ID within the current session. Reuse an ID only for a lost response or the same completed attempt. Waiting does not schedule later activation. If user action is needed or the session cannot keep waiting, state what remains incomplete and the next step. Once active, offer frontend_links.open_portal unchanged so the user can open the branded portal using browser sign-in handoff. Deactivate disables custom addresses and the sender but keeps setup. Discard removes only an unactivated replacement draft and preserves current live addresses.

Operation
write
OAuth scopes
mcp

Availability depends on your assigned tools. Scopes do not grant record access. Read the tool description and current resource before changing it; follow the required revision and idempotency fields below.

Inputs

Name and descriptionRequired
client_request_idSee the input schema for constraints.Yes
expected_revisionCopy branding.revision unchanged from management_groups.get_branding; not an integer draft revision.Yes
lifecycle_actionRead domains[].status and tls_status from management_groups.get_branding. Activate checks current DNS and TLS before turning on a ready pair; deactivate turns off live domains; discard removes an unactivated replacement draft.Yes
management_group_slugCopy management_group_slug from management_groups.list. Prefix: mgmt_.Yes
user_confirmedSee the input schema for constraints.Yes
View exact input schema

Result

Check the structured result for success or an error before continuing. Read the affected record to confirm your change.

View exact output schema

For this workflow’s steps and prerequisites, read the Branding guide.