Skip to main content
POST
Send a reminder email to a consumer
Learn more:
  • How do email reminders work? ↗
  • How to handle activation and redirects? ↗
  • Which errors can this endpoint return? ↗

Path Parameters

consumer_id
string<uuid>
required

Body

application/json
syncid
string<uuid> | null

Sync to remind the consumer to complete. Without it, the consumer is reminded to activate its connection.

language
string | null

Language of the email. Defaults to the public page language of your account.

email
string | null

Recipient of the email, only used when the consumer has no email.

Maximum string length: 80
Pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$

Response

Successful Response