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.

      Contact lists

      Grouped recipients. Business mail only.

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

      List contact lists

      GET /v1/contact-lists  ·  scope mailboxes:read

      Response 200

      List of contact lists

      Field Type Notes
      data array of ContactList

      Errors: 401, 403

      Create a contact list

      POST /v1/contact-lists  ·  scope mailboxes:write

      Request body

      Field Type Notes
      name string Required.
      description string
      visibility string (company_wide, restricted)

      Response 201

      Contact list created

      Field Type Notes
      id string Required.
      tenant_id string Required.
      name string Required.
      description string
      visibility string (company_wide, restricted) Required.
      member_count integer Required.
      created_at string Required.
      updated_at string Required.

      Errors: 400, 401, 403

      Get a contact list with members

      GET /v1/contact-lists/{id}  ·  scope mailboxes:read

      Response 200

      Contact list with members

      Field Type Notes
      list ContactList
      members array of object

      Errors: 401, 403, 404

      Update a contact list

      PATCH /v1/contact-lists/{id}  ·  scope mailboxes:write

      Request body

      Field Type Notes
      name string
      description string
      visibility string (company_wide, restricted)

      Response 200

      Contact list updated

      Field Type Notes
      id string Required.
      tenant_id string Required.
      name string Required.
      description string
      visibility string (company_wide, restricted) Required.
      member_count integer Required.
      created_at string Required.
      updated_at string Required.

      Errors: 400, 401, 403, 404

      Delete a contact list

      DELETE /v1/contact-lists/{id}  ·  scope mailboxes:write

      Response 204

      Contact list deleted

      Errors: 401, 403, 404

      Add a member to a contact list

      POST /v1/contact-lists/{id}/members  ·  scope mailboxes:write

      Request body

      Field Type Notes
      contact_id string Required.

      Response 204

      Member added

      Errors: 400, 401, 403, 404

      Remove a member from a contact list

      DELETE /v1/contact-lists/{id}/members/{contactId}  ·  scope mailboxes:write

      Response 204

      Member removed

      Errors: 401, 403, 404