---
title: "Create a contact channel"
method: POST
path: "/contact-channels"
tags: ["Contact Channels"]
---

# Create a contact channel

`POST /contact-channels`

Add a new contact channel for a user.

## Query parameters

- `user_id` string — The ID of the user, or the special value `me` for the currently authenticated user
- `contact_channel_id` string

## Request body

- object
  - `is_verified` boolean — Whether the contact channel has been verified. If this is set to `true`, the contact channel has been verified to belong to the user.
  - `user_id` string, required — The ID of the user, or the special value `me` for the currently authenticated user
  - `value` string, 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_auth` boolean, 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_primary` boolean — 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 `201`

Successful response

- object
  - `user_id` string, required — The unique identifier of the user
  - `id` string, required — The unique identifier of the contact channel
  - `value` string, 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_auth` boolean, 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_verified` boolean, 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_primary` boolean, 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.

---

[API](https://skmtc.net/hexclave/apis/hexclave-rest-api-2.md) · [All operations](https://skmtc.net/hexclave/apis/hexclave-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hexclave/hexclave-rest-api-2/versions/1c982df54232/schema)