Build and Email Report

POST /api/content/v1/reportschedules/{scheduleId}/notifications

Build and Email Report

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
[
  {
    "userId": 901234,
    "displayName": "John Doe",
    "emailAddress": "[e-mail]"
  }
]
'

import requests

url = "https://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications"

payload = [
    {
        "userId": 901234,
        "displayName": "John Doe",
        "emailAddress": "[e-mail]"
    }
]
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {userId: 901234, displayName: 'John Doe', emailAddress: '[e-mail]'}
  ])
};

fetch('https://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications', 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://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications",
  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([
    [
        'userId' => 901234,
        'displayName' => 'John Doe',
        'emailAddress' => '[e-mail]'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$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://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications"

	payload := strings.NewReader("[\n  {\n    \"userId\": 901234,\n    \"displayName\": \"John Doe\",\n    \"emailAddress\": \"[e-mail]\"\n  }\n]")

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

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")
	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://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"userId\": 901234,\n    \"displayName\": \"John Doe\",\n    \"emailAddress\": \"[e-mail]\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/content/v1/reportschedules/{scheduleId}/notifications")

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

request = Net::HTTP::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"userId\": 901234,\n    \"displayName\": \"John Doe\",\n    \"emailAddress\": \"[e-mail]\"\n  }\n]"

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

Authorizations

X-DOMO-Developer-Token · string · header · required

Path Parameters

scheduleId · integer · required

ID of the schedule

Body

application/json

Array of ReportRecipient objects

userId · integer

displayName · string

emailAddress · string<email>

Response

202

Accepted