> ## Documentation Index > Fetch the complete documentation index at: https://docs.lekalao.com/llms.txt > Use this file to discover all available pages before exploring further. # Subscribe an address > Subscribes the address, or updates the person if they are already on the list. On a double opt-in list the subscriber stays "unconfirmed" and receives the confirmation e-mail, unless `skip_confirmation` is true. An address on the suppression list is refused. ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/lists/{list}/subscribers openapi: 3.1.0 info: title: Lekalao API version: 1.0.0 description: >- Everything the interface does, your application can do too. Every call carries an API token (Settings → API tokens). servers: - url: https://{host} description: Your installation variables: host: default: lekalao.example.com description: The domain of your own Lekalao security: - bearer: [] tags: - name: Lists - name: Subscribers - name: Tags - name: Segments - name: Imports - name: Templates - name: Campaigns - name: Automations - name: Transactional e-mails - name: Revenue - name: Platform paths: /api/v1/lists/{list}/subscribers: post: tags: - Subscribers summary: Subscribe an address description: >- Subscribes the address, or updates the person if they are already on the list. On a double opt-in list the subscriber stays "unconfirmed" and receives the confirmation e-mail, unless `skip_confirmation` is true. An address on the suppression list is refused. operationId: api.subscribers.store parameters: - name: list in: path required: true schema: type: string format: uuid description: The list's identifier (uuid). - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriberInput' - type: object properties: skip_confirmation: type: boolean default: false description: >- Subscribes straight away, even with double opt-in. Only for consent you already hold. example: email: ada@example.com first_name: Ada locale: fr attributes: ville: Douala tags: - client responses: '201': description: The subscriber, created or updated. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Subscriber' example: data: id: 9d5c2a1e-8f3b-4c7a-9e21-3b8f0c6d4a12 email: ada@example.com first_name: Ada last_name: Lovelace timezone: Africa/Douala locale: fr status: subscribed tags: - client - vip attributes: ville: Douala subscribed_at: '2026-09-17T09:30:00+00:00' unsubscribed_at: null created_at: '2026-09-17T09:30:00+00:00' '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '422': description: Invalid data, or a blocked address ("This address is blocked."). content: application/json: schema: $ref: '#/components/schemas/ValidationError' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: >- Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true). schemas: SubscriberInput: type: object required: - email properties: email: type: string format: email maxLength: 255 first_name: type: - string - 'null' maxLength: 255 last_name: type: - string - 'null' maxLength: 255 timezone: type: - string - 'null' description: A valid IANA time zone. locale: type: - string - 'null' description: An ISO 639-1 code, with an optional region (fr, en, pt-BR). attributes: type: object additionalProperties: true description: Merged with the attributes already there. tags: type: array items: type: string maxLength: 255 description: Added to the subscriber's own; an unknown tag is created. Subscriber: type: object properties: id: type: string format: uuid email: type: string format: email first_name: type: - string - 'null' last_name: type: - string - 'null' timezone: type: - string - 'null' description: 'An IANA time zone, such as Africa/Douala. Empty: the list''s own.' locale: type: - string - 'null' description: 'The language this person reads in. Empty: the list''s own.' status: type: string enum: - unconfirmed - subscribed - unsubscribed tags: type: array items: type: string description: There when the tags are loaded (read, create, update). attributes: type: object additionalProperties: true description: Your own fields. list: type: string format: uuid description: There when reading one subscriber. subscribed_at: type: - string - 'null' format: date-time unsubscribed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time ValidationError: type: object properties: message: type: string example: The email field must be a valid email address. errors: type: object additionalProperties: type: array items: type: string Message: type: object properties: message: type: string responses: Unauthenticated: description: No token, or an invalid or revoked one. content: application/json: schema: $ref: '#/components/schemas/Message' example: message: Unauthenticated. Forbidden: description: The token lacks the ability needed, or the team is suspended. content: application/json: schema: $ref: '#/components/schemas/Message' NotFound: description: Nothing of that uuid in the token's team. content: application/json: schema: $ref: '#/components/schemas/Message' TooManyRequests: description: >- The token's limit is reached. Wait the number of seconds Retry-After gives. headers: X-RateLimit-Limit: schema: type: integer description: Calls allowed per minute for this token. X-RateLimit-Remaining: schema: type: integer Retry-After: schema: type: integer securitySchemes: bearer: type: http scheme: bearer description: >- An API token. The "read" ability: GET routes only. "read + write": every route. ````