--- title: Create an On-Call notification channel for a user description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > On-Call --- {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Create an On-Call notification channel for a user{% #create-an-on-call-notification-channel-for-a-user %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/on-call/users/{user_id}/notification-channels | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/on-call/users/{user_id}/notification-channels | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/on-call/users/{user_id}/notification-channels | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/on-call/users/{user_id}/notification-channels | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/on-call/users/{user_id}/notification-channels | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/on-call/users/{user_id}/notification-channels | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/on-call/users/{user_id}/notification-channels | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/on-call/users/{user_id}/notification-channels | ### Overview Create a new notification channel for a user. The authenticated user must be the target user or have the `on_call_admin` permission This endpoint requires the `on_call_respond` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------- | ------ | ----------- | | user_id [*required*] | string | The user ID | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------ | | | data [*required*] | object | Data for creating an on-call notification channel | | data | attributes | object | Attributes for creating an on-call notification channel. | | attributes | config | | Notification channel configuration | | config | Option 1 | object | Configuration to create a phone notification channel | | Option 1 | number [*required*] | string | The E-164 formatted phone number (e.g. +3371234567) | | Option 1 | type [*required*] | enum | Indicates that the notification channel is a phone Allowed enum values: `phone` | | config | Option 2 | object | Configuration to create an e-mail notification channel | | Option 2 | address [*required*] | string | The e-mail address to be notified | | Option 2 | formats [*required*] | [string] | Preferred content formats for notifications. | | Option 2 | type [*required*] | enum | Indicates that the notification channel is an e-mail address Allowed enum values: `email` | | data | type [*required*] | enum | Indicates that the resource is of type 'notification_channels'. Allowed enum values: `notification_channels` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "config": { "address": "foo@bar.com", "formats": [ "html" ], "type": "email" } }, "type": "notification_channels" } } ``` {% /tab %} ### Response {% tab title="201" %} Created {% tab title="Model" %} A top-level wrapper for a user notification channel | Parent field | Field | Type | Description | | ------------ | ---------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------- | | | data | object | Data for an on-call notification channel | | data | attributes | object | Attributes for an on-call notification channel. | | attributes | active | boolean | Whether the notification channel is currently active. | | attributes | config | | Notification channel configuration | | config | Option 1 | object | Phone notification channel configuration | | Option 1 | formatted_number [*required*] | string | The formatted international version of Number (e.g. +33 7 1 23 45 67). | | Option 1 | number [*required*] | string | The E-164 formatted phone number (e.g. +3371234567) | | Option 1 | region [*required*] | string | The ISO 3166-1 alpha-2 two-letter country code. | | Option 1 | sms_subscribed_at | date-time | If present, the date the user subscribed this number to SMS messages | | Option 1 | type [*required*] | enum | Indicates that the notification channel is a phone Allowed enum values: `phone` | | Option 1 | verified [*required*] | boolean | Indicates whether this phone has been verified by the user in Datadog On-Call | | config | Option 2 | object | Email notification channel configuration | | Option 2 | address [*required*] | string | The e-mail address to be notified | | Option 2 | formats [*required*] | [string] | Preferred content formats for notifications. | | Option 2 | type [*required*] | enum | Indicates that the notification channel is an e-mail address Allowed enum values: `email` | | config | Option 3 | object | Push notification channel configuration | | Option 3 | application_name [*required*] | string | The name of the application used to receive push notifications | | Option 3 | device_name [*required*] | string | The name of the mobile device being used | | Option 3 | type [*required*] | enum | Indicates that the notification channel is a mobile device for push notifications Allowed enum values: `push` | | data | id | string | Unique identifier for the channel | | data | type [*required*] | enum | Indicates that the resource is of type 'notification_channels'. Allowed enum values: `notification_channels` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "config": { "address": "foo@bar.com", "formats": [ "html" ], "type": "email" } }, "id": "27590dae-47be-4a7d-9abf-8f4e45124020", "type": "notification_channels" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Unauthorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export user_id="00000000-0000-0000-0000-000000000000" \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/on-call/users/${user_id}/notification-channels" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "config": { "address": "foo@bar.com", "formats": [ "html" ], "type": "email" } }, "type": "notification_channels" } } EOF ##### ```go // Create an On-Call notification channel for a user returns "Created" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { // there is a valid "user" in the system UserDataID := os.Getenv("USER_DATA_ID") body := datadogV2.CreateUserNotificationChannelRequest{ Data: datadogV2.CreateNotificationChannelData{ Attributes: &datadogV2.CreateNotificationChannelAttributes{ Config: &datadogV2.CreateNotificationChannelConfig{ CreateEmailNotificationChannelConfig: &datadogV2.CreateEmailNotificationChannelConfig{ Address: "foo@bar.com", Formats: []datadogV2.NotificationChannelEmailFormatType{ datadogV2.NOTIFICATIONCHANNELEMAILFORMATTYPE_HTML, }, Type: datadogV2.NOTIFICATIONCHANNELEMAILCONFIGTYPE_EMAIL, }}, }, Type: datadogV2.NOTIFICATIONCHANNELTYPE_NOTIFICATION_CHANNELS, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewOnCallApi(apiClient) resp, r, err := api.CreateUserNotificationChannel(ctx, UserDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `OnCallApi.CreateUserNotificationChannel`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `OnCallApi.CreateUserNotificationChannel`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create an On-Call notification channel for a user returns "Created" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.OnCallApi; import com.datadog.api.client.v2.model.CreateEmailNotificationChannelConfig; import com.datadog.api.client.v2.model.CreateNotificationChannelAttributes; import com.datadog.api.client.v2.model.CreateNotificationChannelConfig; import com.datadog.api.client.v2.model.CreateNotificationChannelData; import com.datadog.api.client.v2.model.CreateUserNotificationChannelRequest; import com.datadog.api.client.v2.model.NotificationChannel; import com.datadog.api.client.v2.model.NotificationChannelEmailConfigType; import com.datadog.api.client.v2.model.NotificationChannelEmailFormatType; import com.datadog.api.client.v2.model.NotificationChannelType; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); OnCallApi apiInstance = new OnCallApi(defaultClient); // there is a valid "user" in the system String USER_DATA_ID = System.getenv("USER_DATA_ID"); CreateUserNotificationChannelRequest body = new CreateUserNotificationChannelRequest() .data( new CreateNotificationChannelData() .attributes( new CreateNotificationChannelAttributes() .config( new CreateNotificationChannelConfig( new CreateEmailNotificationChannelConfig() .address("foo@bar.com") .formats( Collections.singletonList( NotificationChannelEmailFormatType.HTML)) .type(NotificationChannelEmailConfigType.EMAIL)))) .type(NotificationChannelType.NOTIFICATION_CHANNELS)); try { NotificationChannel result = apiInstance.createUserNotificationChannel(USER_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling OnCallApi#createUserNotificationChannel"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Create an On-Call notification channel for a user returns "Created" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.on_call_api import OnCallApi from datadog_api_client.v2.model.create_email_notification_channel_config import CreateEmailNotificationChannelConfig from datadog_api_client.v2.model.create_notification_channel_attributes import CreateNotificationChannelAttributes from datadog_api_client.v2.model.create_notification_channel_data import CreateNotificationChannelData from datadog_api_client.v2.model.create_user_notification_channel_request import CreateUserNotificationChannelRequest from datadog_api_client.v2.model.notification_channel_email_config_type import NotificationChannelEmailConfigType from datadog_api_client.v2.model.notification_channel_email_format_type import NotificationChannelEmailFormatType from datadog_api_client.v2.model.notification_channel_type import NotificationChannelType # there is a valid "user" in the system USER_DATA_ID = environ["USER_DATA_ID"] body = CreateUserNotificationChannelRequest( data=CreateNotificationChannelData( attributes=CreateNotificationChannelAttributes( config=CreateEmailNotificationChannelConfig( address="foo@bar.com", formats=[ NotificationChannelEmailFormatType.HTML, ], type=NotificationChannelEmailConfigType.EMAIL, ), ), type=NotificationChannelType.NOTIFICATION_CHANNELS, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = OnCallApi(api_client) response = api_instance.create_user_notification_channel(user_id=USER_DATA_ID, body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create an On-Call notification channel for a user returns "Created" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::OnCallAPI.new # there is a valid "user" in the system USER_DATA_ID = ENV["USER_DATA_ID"] body = DatadogAPIClient::V2::CreateUserNotificationChannelRequest.new({ data: DatadogAPIClient::V2::CreateNotificationChannelData.new({ attributes: DatadogAPIClient::V2::CreateNotificationChannelAttributes.new({ config: DatadogAPIClient::V2::CreateEmailNotificationChannelConfig.new({ address: "foo@bar.com", formats: [ DatadogAPIClient::V2::NotificationChannelEmailFormatType::HTML, ], type: DatadogAPIClient::V2::NotificationChannelEmailConfigType::EMAIL, }), }), type: DatadogAPIClient::V2::NotificationChannelType::NOTIFICATION_CHANNELS, }), }) p api_instance.create_user_notification_channel(USER_DATA_ID, body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create an On-Call notification channel for a user returns "Created" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_on_call::OnCallAPI; use datadog_api_client::datadogV2::model::CreateEmailNotificationChannelConfig; use datadog_api_client::datadogV2::model::CreateNotificationChannelAttributes; use datadog_api_client::datadogV2::model::CreateNotificationChannelConfig; use datadog_api_client::datadogV2::model::CreateNotificationChannelData; use datadog_api_client::datadogV2::model::CreateUserNotificationChannelRequest; use datadog_api_client::datadogV2::model::NotificationChannelEmailConfigType; use datadog_api_client::datadogV2::model::NotificationChannelEmailFormatType; use datadog_api_client::datadogV2::model::NotificationChannelType; #[tokio::main] async fn main() { // there is a valid "user" in the system let user_data_id = std::env::var("USER_DATA_ID").unwrap(); let body = CreateUserNotificationChannelRequest::new( CreateNotificationChannelData::new(NotificationChannelType::NOTIFICATION_CHANNELS) .attributes(CreateNotificationChannelAttributes::new().config( CreateNotificationChannelConfig::CreateEmailNotificationChannelConfig(Box::new( CreateEmailNotificationChannelConfig::new( "foo@bar.com".to_string(), vec![NotificationChannelEmailFormatType::HTML], NotificationChannelEmailConfigType::EMAIL, ), )), )), ); let configuration = datadog::Configuration::new(); let api = OnCallAPI::with_config(configuration); let resp = api .create_user_notification_channel(user_data_id.clone(), body) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create an On-Call notification channel for a user returns "Created" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.OnCallApi(configuration); // there is a valid "user" in the system const USER_DATA_ID = process.env.USER_DATA_ID as string; const params: v2.OnCallApiCreateUserNotificationChannelRequest = { body: { data: { attributes: { config: { address: "foo@bar.com", formats: ["html"], type: "email", }, }, type: "notification_channels", }, }, userId: USER_DATA_ID, }; apiInstance .createUserNotificationChannel(params) .then((data: v2.NotificationChannel) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}