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

# Send a reminder email to a consumer

> Sends the consumer the reminder email of your account, with a link valid for 3 days: to complete a sync when a syncid is passed, to activate its connection otherwise. Answers HTTP 422 when the consumer has nothing left to complete. The email goes to the email of the consumer, or to the one passed when the consumer has none. Returns HTTP 204 on success.

**Learn more:**

* How do email reminders work? [↗](https://docs.chift.eu/platform/user-onboarding/email-reminders.md)
* How to handle activation and redirects? [↗](https://docs.chift.eu/unified-apis/guides/activation-and-redirects.md)
* Which errors can this endpoint return? [↗](https://docs.chift.eu/home/errors.md)


## OpenAPI

````yaml post /consumers/{consumer_id}/reminders
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/reminders:
    post:
      tags:
        - Consumers
      summary: Send a reminder email to a consumer
      description: >-
        Sends the consumer the reminder email of your account, with a link valid
        for 3 days: to complete a sync when a syncid is passed, to activate its
        connection otherwise. Answers HTTP 422 when the consumer has nothing
        left to complete. The email goes to the email of the consumer, or to the
        one passed when the consumer has none. Returns HTTP 204 on success.
      operationId: consumers_send_reminder
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/PostReminderItem'
                - type: 'null'
              title: Item
      responses:
        '204':
          description: Successful Response
        '404':
          content:
            application/json:
              examples:
                consumer:
                  value:
                    message: The consumer does not exist
                    status: error
                sync:
                  value:
                    message: The sync does not exist for this consumer
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '422':
          content:
            application/json:
              examples:
                recipient:
                  value:
                    message: The consumer has no email and none was specified
                    status: error
                nothing to complete:
                  value:
                    message: The consumer has nothing left to complete
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Unprocessable Entity
        '502':
          content:
            application/json:
              example:
                message: The reminder email could not be sent
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Bad Gateway
      security:
        - mcp_auth:
            - consumers
components:
  schemas:
    PostReminderItem:
      properties:
        syncid:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Syncid
          description: >-
            Sync to remind the consumer to complete. Without it, the consumer is
            reminded to activate its connection.
        language:
          anyOf:
            - type: string
            - type: 'null'
          title: Language
          description: >-
            Language of the email. Defaults to the public page language of your
            account.
        email:
          anyOf:
            - type: string
              maxLength: 80
              pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$
            - type: 'null'
          title: Email
          description: Recipient of the email, only used when the consumer has no email.
      type: object
      title: PostReminderItem
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      required:
        - message
      title: ChiftError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````

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