Sign in

v16

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01720230.5 KB
Contact Channels

Update a contact channel

Updates an existing contact channel. Only the values provided will be updated.

patch/contact-channels/{user_id}/{contact_channel_id}

Path parameters

user_idstring required

the user that the contact channel belongs to

Example:me

the user that the contact channel belongs to

contact_channel_idstring required

the target contact channel

Example:b3d396b8-c574-4c80-97b3-50031675ceb2

the target contact channel

Query parameters

user_idstring

The ID of the user, or the special value me for the currently authenticated user

Example:3241a285-8329-4d69-8f3d-316e08cf140c

The ID of the user, or the special value me for the currently authenticated user

contact_channel_idstring

Request body

valuestring

The value of the contact channel. For email, this should be a valid email address.

type'email'

The type of the contact channel. Currently only "email" is supported.

used_for_authboolean

Whether the contact channel is used for authentication. If this is set to true, the user will be able to sign in with the contact channel with password or OTP.

is_primaryboolean

Whether the contact channel is the primary contact channel. If this is set to true, it will be used for authentication and notifications by default.

Example request

{
  "value": "johndoe@example.com",
  "type": "email",
  "used_for_auth": true,
  "is_primary": true
}

Response

Successful response

user_idstring required

The unique identifier of the user

idstring required

The unique identifier of the contact channel

valuestring required

The value of the contact channel. For email, this should be a valid email address.

type'email' required

The type of the contact channel. Currently only "email" is supported.

used_for_authboolean required

Whether the contact channel is used for authentication. If this is set to true, the user will be able to sign in with the contact channel with password or OTP.

is_verifiedboolean required

Whether the contact channel has been verified. If this is set to true, the contact channel has been verified to belong to the user.

is_primaryboolean required

Whether the contact channel is the primary contact channel. If this is set to true, it will be used for authentication and notifications by default.

Example response

{
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "id": "b3d396b8-c574-4c80-97b3-50031675ceb2",
  "value": "johndoe@example.com",
  "type": "email",
  "used_for_auth": true,
  "is_verified": true,
  "is_primary": true
}