> ## Documentation Index
> Fetch the complete documentation index at: https://api.tipee.ch/llms.txt
> Use this file to discover all available pages before exploring further.

# Send by email

> Emails a login link to a person. A person can receive at most one link every 15 minutes.

> [!WARNING]
>
> This endpoint is in preview: it may change without notice until it becomes part of a stable version.


## OpenAPI

````yaml preview post /api/security/login-links.send-by-email
openapi: 3.1.0
info:
  title: tipee
  version: preview
servers: []
security:
  - basicAuth: []
tags:
  - name: Activity
    description: Activity
  - name: Balances
    description: Balances
  - name: Directory
    description: Directory
  - name: Expenses
    description: Expenses
  - name: Schedule
    description: Schedule
  - name: Security
    description: Security
  - name: Timeclock
    description: Timeclock
paths:
  /api/security/login-links.send-by-email:
    post:
      tags:
        - Security
      summary: Send by email
      description: >-
        Emails a login link to a person. A person can receive at most one link
        every 15 minutes.
      operationId: post_app_ui_api_security_logincommand_sendbyemail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendLoginLinkByEmailCommand'
      responses:
        '204':
          description: Login link sent.
components:
  schemas:
    SendLoginLinkByEmailCommand:
      required:
        - resource_id
      properties:
        resource_id:
          $ref: '#/components/schemas/Snowflake'
          description: >-
            Refused on a person who is not an employee, on one's own account, on
            an account without a username, and on an account that already has a
            password outside onboarding.
        email_type:
          $ref: '#/components/schemas/EmailType'
          description: >-
            The address to send the link to. Defaults to the professional
            address if it exists, or the private one otherwise.
      type: object
      additionalProperties: false
    Snowflake:
      type: string
      format: snowflake
      example: '872815618512410358'
    EmailType:
      type: string
      example: professional
      enum:
        - professional
        - personal

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.