Server APIContact Channels

Update a contact channel

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

Path parameters

user_idstringRequired
the user that the contact channel belongs to
contact_channel_idstringRequired
the target contact channel

Query parameters

user_idstringOptional

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

contact_channel_idstringOptional

Request

This endpoint expects an object.
is_verifiedbooleanOptional

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

valuestringOptional
The value of the contact channel. For email, this should be a valid email address.
typestringOptional
The type of the contact channel. Currently only "email" is supported.
used_for_authbooleanOptional

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_primarybooleanOptional

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.

Response

Successful response
user_idstring
The unique identifier of the user
idstring
The unique identifier of the contact channel
valuestring
The value of the contact channel. For email, this should be a valid email address.
typestring
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_verifiedboolean

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

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.