Save push notification setting.

curl --request POST \
  --url https://apix.us.amity.co/api/v3/notification/setting \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPushNotifiable": true,
  "channelId": "<string>",
  "communityId": "<string>",
  "notifiableEvents": [
    {
      "isPushNotifiable": true,
      "titleTemplate": "<string>",
      "bodyTemplate": "<string>",
      "listenFromRoleIds": [
        "<string>"
      ],
      "ignoreFromRoleIds": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://apix.us.amity.co/api/v3/notification/setting"

payload = {
    "isPushNotifiable": True,
    "channelId": "<string>",
    "communityId": "<string>",
    "notifiableEvents": [
        {
            "isPushNotifiable": True,
            "titleTemplate": "<string>",
            "bodyTemplate": "<string>",
            "listenFromRoleIds": ["<string>"],
            "ignoreFromRoleIds": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isPushNotifiable: true,
    channelId: '<string>',
    communityId: '<string>',
    notifiableEvents: [
      {
        isPushNotifiable: true,
        titleTemplate: '<string>',
        bodyTemplate: '<string>',
        listenFromRoleIds: ['<string>'],
        ignoreFromRoleIds: ['<string>']
      }
    ]
  })
};

fetch('https://apix.us.amity.co/api/v3/notification/setting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/notification/setting",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'isPushNotifiable' => true,
    'channelId' => '<string>',
    'communityId' => '<string>',
    'notifiableEvents' => [
        [
                'isPushNotifiable' => true,
                'titleTemplate' => '<string>',
                'bodyTemplate' => '<string>',
                'listenFromRoleIds' => [
                                '<string>'
                ],
                'ignoreFromRoleIds' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://apix.us.amity.co/api/v3/notification/setting"

	payload := strings.NewReader("{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v3/notification/setting")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/notification/setting")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

{
  "status": "error",
  "code": 400301,
  "message": "User is not a member of a channel"
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 400311,
  "message": "RateLimit Exceed."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

POST

api

notification

setting

Save push notification setting.

curl --request POST \
  --url https://apix.us.amity.co/api/v3/notification/setting \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isPushNotifiable": true,
  "channelId": "<string>",
  "communityId": "<string>",
  "notifiableEvents": [
    {
      "isPushNotifiable": true,
      "titleTemplate": "<string>",
      "bodyTemplate": "<string>",
      "listenFromRoleIds": [
        "<string>"
      ],
      "ignoreFromRoleIds": [
        "<string>"
      ]
    }
  ]
}
'

import requests

url = "https://apix.us.amity.co/api/v3/notification/setting"

payload = {
    "isPushNotifiable": True,
    "channelId": "<string>",
    "communityId": "<string>",
    "notifiableEvents": [
        {
            "isPushNotifiable": True,
            "titleTemplate": "<string>",
            "bodyTemplate": "<string>",
            "listenFromRoleIds": ["<string>"],
            "ignoreFromRoleIds": ["<string>"]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isPushNotifiable: true,
    channelId: '<string>',
    communityId: '<string>',
    notifiableEvents: [
      {
        isPushNotifiable: true,
        titleTemplate: '<string>',
        bodyTemplate: '<string>',
        listenFromRoleIds: ['<string>'],
        ignoreFromRoleIds: ['<string>']
      }
    ]
  })
};

fetch('https://apix.us.amity.co/api/v3/notification/setting', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/notification/setting",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'isPushNotifiable' => true,
    'channelId' => '<string>',
    'communityId' => '<string>',
    'notifiableEvents' => [
        [
                'isPushNotifiable' => true,
                'titleTemplate' => '<string>',
                'bodyTemplate' => '<string>',
                'listenFromRoleIds' => [
                                '<string>'
                ],
                'ignoreFromRoleIds' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://apix.us.amity.co/api/v3/notification/setting"

	payload := strings.NewReader("{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://apix.us.amity.co/api/v3/notification/setting")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/notification/setting")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isPushNotifiable\": true,\n  \"channelId\": \"<string>\",\n  \"communityId\": \"<string>\",\n  \"notifiableEvents\": [\n    {\n      \"isPushNotifiable\": true,\n      \"titleTemplate\": \"<string>\",\n      \"bodyTemplate\": \"<string>\",\n      \"listenFromRoleIds\": [\n        \"<string>\"\n      ],\n      \"ignoreFromRoleIds\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

{
  "status": "error",
  "code": 400301,
  "message": "User is not a member of a channel"
}

{
  "status": "error",
  "code": 400400,
  "message": "Resource Not Found."
}

{
  "status": "error",
  "code": 400311,
  "message": "RateLimit Exceed."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Notification setting information to be updated

level

enum<string>

required

level:

user - need to specific modules via notifiableEvents.
channel - need to specific channelId.
community - need to specific communityId and community event via notifiableEvents.

Available options:

user,

channel,

community

isPushNotifiable

boolean

channelId

string

Required string length: 1 - 900

communityId

string

Required string length: 1 - 900

notifiableEvents

object[]

Required array length: 1 - 7 elements

Show child attributes

Response

save information

status

string

Get push notification setting.Get user's notification tray items

⌘I