Skip to main content
POST
Customize application email

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app the emails belong to.

email_type
string
required

The application email: password_reset, email_verification, user_invite, or access_approved.

Response

The app's template for the email.

The app's own template for an application email.

template_id
string
required

ID of the template. Use it with Get email template.

Example:

"68c1f0a2b3d4e5f6a7b8c9d0"

name
string
required

Name of the template: PasswordReset, EmailVerification, UserInvite, or AccessApproved.

Example:

"PasswordReset"

created
boolean
required

true when this request created the template, and false when the app already had it.

Example:

true