Magic link template - EmailsDone Docs

authentication Stable Latest stable

Magic link v1

magic-link - v1

Subject: Your sign-in link for {{projectName}}

Preheader: Use this secure link to sign in.

Required fields

Name	Type	Required	Description	Example
`actionButton.url`	url	Yes	Action Button URL Max 2048 characters	`https://example.com/app`

Optional fields

Name	Type	Required	Description	Example
`actionButton.label`	text	No	Action Button Label Max 120 characters	`Sign in`
`footerNote`	text	No	Footer Note Max 1000 characters	`If you did not request this email, you can safely ignore it.`
`heading`	text	No	Heading Max 180 characters	`Sign in to your account`
`intro`	text	No	Intro Max 1000 characters	`Use this secure link to sign in. This link is private and will expire soon.`
`preheader`	text	No	Preheader Max 220 characters	`Use this secure link to sign in.`
`subject`	text	No	Subject Max 180 characters	`Your sign-in link for Project Name`

Defaults

{
  "actionButton.label": "Sign in",
  "footerNote": "If you did not request this email, you can safely ignore it.",
  "heading": "Sign in to your account",
  "intro": "Use this secure link to sign in. This link is private and will expire soon.",
  "preheader": "Use this secure link to sign in.",
  "subject": "Your sign-in link for {{projectName}}"
}

Example data

{
  "templateId": "magic-link",
  "data": {
    "actionButton": {
      "url": "https://example.com/app"
    }
  }
}

Template messages

Type	Code	Message
Return	`accepted`	Valid template data can be queued by the send endpoint.
Error	`missing_required_variable`	Action Button URL is required.
Error	`field_too_long`	Action Button URL must be 2048 characters or fewer.
Error	`invalid_url`	Action Button URL must be a valid http or https URL.
Error	`field_too_long`	Action Button Label must be 120 characters or fewer.
Error	`field_too_long`	Footer Note must be 1000 characters or fewer.
Error	`field_too_long`	Heading must be 180 characters or fewer.
Error	`field_too_long`	Intro must be 1000 characters or fewer.
Error	`field_too_long`	Preheader must be 220 characters or fewer.
Error	`field_too_long`	Subject must be 180 characters or fewer.