Skip to main content
PATCH
/
users
/
{user_id}
/
emails
/
{email_id}
Update email address
curl --request PATCH \
  --url https://api.wacht.dev/users/{user_id}/emails/{email_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jane.doe@example.com",
  "is_primary": true
}
'
{
  "id": "9876543210",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "deployment_id": "1234567890",
  "user_id": "1234567890",
  "email": "john.doe@example.com",
  "is_primary": true,
  "verified": true,
  "verified_at": "2024-01-15T10:35:00Z",
  "verification_strategy": "otp"
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Path Parameters

​
user_id
string
required

User ID (integer as string)

​
email_id
string
required

Email ID (integer as string)

Body

application/json
​
email
string<email>

New email address

Example:

"jane.doe@example.com"

​
is_primary
boolean

Set as primary email address

Example:

true

Response

Email updated successfully

​
id
string
required

Email ID (integer serialized as string)

Example:

"9876543210"

​
created_at
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

​
deployment_id
string
required

Deployment ID (integer serialized as string)

Example:

"1234567890"

​
user_id
string
required

User ID (integer serialized as string)

Example:

"1234567890"

​
email
string<email>
required

Email address

Example:

"john.doe@example.com"

​
is_primary
boolean
required

Whether this is the primary email

Example:

true

​
verified
boolean
required

Whether the email has been verified

Example:

true

​
verified_at
string<date-time>
required

Verification timestamp

Example:

"2024-01-15T10:35:00Z"

​
verification_strategy
enum<string>
required

Verification method used

Available options:
otp,
oauth_google,
oauth_github,
oauth_microsoft,
oauth_facebook,
oauth_linkedin,
oauth_discord,
oauth_apple
Example:

"otp"