> ## Documentation Index > Fetch the complete documentation index at: https://docs.lobbystack.com/llms.txt > Use this file to discover all available pages before exploring further. # Connect the partner's own domain > Adds a domain of the partner's own, such as app.youragency.com, and returns the DNS records to add. The partner can have one: remove the current one first, or it's a 409. Only a partner on a paid tier can add one where the deployment bills tiers. ## OpenAPI ````yaml /api-reference/openapi.json post /partner/domain openapi: 3.1.0 info: title: LobbyStack API version: v1 description: >- Read calls, contacts, appointments and messages, book appointments, and subscribe to webhooks. Authenticate with an API key in the Authorization header. A platform key also names the business it acts on in the LobbyStack-Business header. Each key allows 120 requests per minute by default. servers: - url: https://app.lobbystack.com/api/v1 security: - bearerAuth: [] tags: - name: Business - name: Receptionist - name: Agents - name: Billing - name: Phone numbers - name: Onboarding - name: Team - name: Website chat - name: Calendars - name: Notifications - name: Calls - name: Contacts - name: Appointments - name: Messages - name: Knowledge - name: Webhooks - name: Platform - name: Partner paths: /partner/domain: post: tags: - Partner summary: Connect the partner's own domain description: >- Adds a domain of the partner's own, such as app.youragency.com, and returns the DNS records to add. The partner can have one: remove the current one first, or it's a 409. Only a partner on a paid tier can add one where the deployment bills tiers. operationId: addPartnerDomain requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PartnerDomainCreate' responses: '201': description: Created content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/PartnerDomains' '400': description: The request is invalid (invalid_request). content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: The API key is missing, invalid, or revoked (unauthorized). content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- Refused. insufficient_scope: the key lacks the partner.branding:write scope. forbidden: only a partner's platform keys can call this endpoint, or what only the partner's owners may do. key_owner_inactive: the person the key acts for can't any more: a per-business key's creator is no longer an owner or admin, or a platform key's owner_email has no verified LobbyStack account. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The request conflicts with the current state. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: >- Too many requests (rate_limited). Wait for the Retry-After header's number of seconds. content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: integer description: Seconds to wait. security: - bearerAuth: [] components: schemas: PartnerDomainCreate: type: object properties: hostname: type: string minLength: 1 maxLength: 253 description: A subdomain of the partner's own domain, such as app.youragency.com. required: - hostname additionalProperties: false PartnerDomains: type: object properties: subdomain: type: - string - 'null' subdomain_url: type: - string - 'null' custom_domains: type: string enum: - available - paid_tier_required - unavailable description: >- Whether the partner can add its own domain: yes, once it pays for a tier, or never on this deployment. custom: anyOf: - type: object properties: hostname: type: string status: type: string enum: - pending - active - failed records: type: array items: type: object properties: type: type: string enum: - CNAME - TXT name: type: string value: type: string verified: type: boolean required: - type - name - value - verified additionalProperties: false description: >- The records to add at the domain's DNS provider. Empty until the provider first answers. errors: type: array items: type: string checked_at: anyOf: - type: string format: date-time description: ISO 8601 timestamp in UTC. - type: 'null' description: >- When LobbyStack last checked the records. It checks a waiting domain every minute in its first hour, every 5 minutes in its first day, then hourly. url: type: - string - 'null' taken: type: boolean description: Another partner proved it controls this domain first. required: - hostname - status - records - errors - checked_at - url - taken additionalProperties: false - type: 'null' required: - subdomain - subdomain_url - custom_domains - custom additionalProperties: false Error: type: object properties: error: type: object properties: code: type: string enum: - invalid_request - unauthorized - forbidden - insufficient_scope - not_found - conflict - idempotency_key_reused - idempotency_request_in_progress - booking_disabled - booking_requires_confirmation - slot_unavailable - rate_limited - rate_limit_unavailable - method_not_allowed - internal_error - business_required - key_owner_inactive - plan_limit_reached - phone_numbers_unavailable message: type: string details: type: array items: type: object properties: path: type: string message: type: string required: - path - message additionalProperties: false required: - code - message additionalProperties: false required: - error additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.