PingOne Platform APIs

Create Notification Policy / User

 

POST {{apiPath}}/environments/{{envID}}/notificationsPolicies

When you use the POST {{apiPath}}/environments/{{envID}}/notificationsPolicies endpoint and specify USER as the type along with the total field, a policy is created to limit the total number of notifications that can be sent to each user each day. This example limits both SMS/voice notifications and email notifications.

Prerequisites

Request Model
Property Type Required?

default

Boolean

Optional

name

String

Required

quotas

Array

Required

quotas[].type

String

Required

quotas[].deliveryMethods

Array

Required

quotas[].total

Integer

Required/Optional

Refer to the Notification policies data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": false
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/notificationsPolicies' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": false
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/notificationsPolicies")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""name"": ""Per-User Notification Policy - SMS/voice and email limits""," + "\n" +
@"  ""quotas"": [" + "\n" +
@"    {" + "\n" +
@"      ""type"": ""USER""," + "\n" +
@"      ""deliveryMethods"": [" + "\n" +
@"        ""SMS""," + "\n" +
@"        ""Voice""" + "\n" +
@"      ]," + "\n" +
@"      ""total"": 30" + "\n" +
@"    }," + "\n" +
@"    {" + "\n" +
@"      ""type"": ""USER""," + "\n" +
@"      ""deliveryMethods"": [" + "\n" +
@"        ""Email""" + "\n" +
@"      ]," + "\n" +
@"      ""total"": 25" + "\n" +
@"    }" + "\n" +
@"  ]," + "\n" +
@"  ""default"": false" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/notificationsPolicies"
  method := "POST"

  payload := strings.NewReader(`{
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": false
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
POST /environments/{{envID}}/notificationsPolicies HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": false
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"Per-User Notification Policy - SMS/voice and email limits\",\n  \"quotas\": [\n    {\n      \"type\": \"USER\",\n      \"deliveryMethods\": [\n        \"SMS\",\n        \"Voice\"\n      ],\n      \"total\": 30\n    },\n    {\n      \"type\": \"USER\",\n      \"deliveryMethods\": [\n        \"Email\"\n      ],\n      \"total\": 25\n    }\n  ],\n  \"default\": false\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/notificationsPolicies")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/notificationsPolicies",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "Per-User Notification Policy - SMS/voice and email limits",
    "quotas": [
      {
        "type": "USER",
        "deliveryMethods": [
          "SMS",
          "Voice"
        ],
        "total": 30
      },
      {
        "type": "USER",
        "deliveryMethods": [
          "Email"
        ],
        "total": 25
      }
    ],
    "default": false
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/notificationsPolicies',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "Per-User Notification Policy - SMS/voice and email limits",
    "quotas": [
      {
        "type": "USER",
        "deliveryMethods": [
          "SMS",
          "Voice"
        ],
        "total": 30
      },
      {
        "type": "USER",
        "deliveryMethods": [
          "Email"
        ],
        "total": 25
      }
    ],
    "default": false
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/notificationsPolicies"

payload = json.dumps({
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": False
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/notificationsPolicies');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "name": "Per-User Notification Policy - SMS/voice and email limits",\n  "quotas": [\n    {\n      "type": "USER",\n      "deliveryMethods": [\n        "SMS",\n        "Voice"\n      ],\n      "total": 30\n    },\n    {\n      "type": "USER",\n      "deliveryMethods": [\n        "Email"\n      ],\n      "total": 25\n    }\n  ],\n  "default": false\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/notificationsPolicies")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "Per-User Notification Policy - SMS/voice and email limits",
  "quotas": [
    {
      "type": "USER",
      "deliveryMethods": [
        "SMS",
        "Voice"
      ],
      "total": 30
    },
    {
      "type": "USER",
      "deliveryMethods": [
        "Email"
      ],
      "total": 25
    }
  ],
  "default": false
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"name\": \"Per-User Notification Policy - SMS/voice and email limits\",\n  \"quotas\": [\n    {\n      \"type\": \"USER\",\n      \"deliveryMethods\": [\n        \"SMS\",\n        \"Voice\"\n      ],\n      \"total\": 30\n    },\n    {\n      \"type\": \"USER\",\n      \"deliveryMethods\": [\n        \"Email\"\n      ],\n      \"total\": 25\n    }\n  ],\n  \"default\": false\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/notificationsPolicies")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsPolicies/62b4279f-1bd6-4bdf-9db0-5f38d4bfdc32"
        },
        "environment": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "62b4279f-1bd6-4bdf-9db0-5f38d4bfdc32",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "Per-User Notification Policy - SMS/voice and email limits",
    "quotas": [
        {
            "type": "USER",
            "deliveryMethods": [
                "SMS",
                "Voice"
            ],
            "total": 30
        },
        {
            "type": "USER",
            "deliveryMethods": [
                "Email"
            ],
            "total": 25
        }
    ],
    "countryLimit": {
        "type": "NONE"
    },
    "updatedAt": "2023-04-16T11:33:38.088Z",
    "createdAt": "2023-04-16T11:33:38.090Z",
    "default": false
}