Lockally

      Use your API key in the examples

      Replaces lk_live_… in the code samples on this site so you can copy and run them. It is stored in this browser only and is never sent anywhere, including to Ask AI.

      It will be visible on the page. Use a test key if you are sharing your screen or taking screenshots.

      Aliases

      Extra addresses on a verified domain. An alias is not a billed seat.

      Every endpoint needs Authorization: Bearer lk_live_.... See Conventions for headers, status codes and error shape.

      List aliases

      GET /v1/aliases  ·  scope mailboxes:read

      Response 200

      Alias list.

      Field Type Notes
      data array of Alias Required.

      Errors: 401, 403

      Create an alias

      POST /v1/aliases  ·  scope mailboxes:write

      Creates an email alias. alias_address must be on a verified tenant-owned domain and must not be the address of an existing mailbox (live, suspended or deleted). alias_target must be an active mailbox in the same workspace; forwarding to an address Lockally does not host is not supported. The alias delivers as soon as the call returns.

      Request body

      Field Type Notes
      alias_address string Required.
      alias_target string Required.

      Response 201

      Alias created.

      Field Type Notes
      id string Required.
      tenant_id string Required.
      alias_address string Required.
      alias_target string Required.
      created_at string Required.

      Errors: 400, 401, 403, 409

      Delete an alias

      DELETE /v1/aliases/{address}  ·  scope mailboxes:write

      Hard-delete (no soft-delete window, aliases are cheap to recreate).

      Parameters

      Name In Type Notes
      address path string Required.

      Response 204

      Deleted.

      Errors: 401, 403, 404