Email Addresses

A user can be associated with one or more email addresses, which allows them to be contacted via email.

https://clerk.com/docs/reference/clerkjs/emailaddress

Create an email address

Create a new email address

SecuritybearerAuth

Request

Request Body schema: application/json

user_id	string The ID representing the user
email_address	string The new email address. Must adhere to the RFC 5322 specification for email address format.
verified	boolean or null When created, the email address will be marked as verified.
primary	boolean or null Create this email address as the primary email address for the user. Default: false, unless it is the first email address.

Responses

200

Success

400

Request was not successful

401

Authentication invalid

403

Authorization invalid

404

Resource not found

422

Invalid request parameters

post/email_addresses

Request samples

Payload

application/json

{"user_id": "string",
"email_address": "string",
"verified": true,
"primary": true
}

Response samples

application/json

{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_google",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}

Retrieve an email address

Returns the details of an email address.

SecuritybearerAuth

Request

path Parameters

email_address_id

required

string

The ID of the email address to retrieve

Responses

200

Success

400

Request was not successful

401

Authentication invalid

403

Authorization invalid

404

Resource not found

get/email_addresses/{email_address_id}

Response samples

application/json

{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_google",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}

Delete an email address

Delete the email address with the given ID

SecuritybearerAuth

Request

path Parameters

email_address_id

required

string

The ID of the email address to delete

Responses

200

Deleted Object

400

Request was not successful

401

Authentication invalid

403

Authorization invalid

404

Resource not found

delete/email_addresses/{email_address_id}

Response samples

application/json

{"object": "string",
"id": "string",
"slug": "string",
"deleted": true
}

Update an email address

Updates an email address.

SecuritybearerAuth

Request

path Parameters

email_address_id

required

string

The ID of the email address to update

Request Body schema: application/json

verified	boolean or null The email address will be marked as verified.
primary	boolean or null Set this email address as the primary email address for the user.

Responses

200

Success

400

Request was not successful

401

Authentication invalid

403

Authorization invalid

404

Resource not found

patch/email_addresses/{email_address_id}

Request samples

Payload

application/json

{"verified": true,
"primary": true
}

Response samples

application/json

{"id": "string",
"object": "email_address",
"email_address": "string",
"reserved": true,
"verification": {"status": "unverified",
"strategy": "phone_code",
"attempts": 0,
"expire_at": 0
},
"linked_to": [{"type": "oauth_google",
"id": "string"
}
],
"created_at": 0,
"updated_at": 0
}

➔ Next to Email & SMS Templates