Update report settings

Update the Slack channel used for workspace reports.

PATCH /api/settings/report

Update report settings

cURL

curl --request PATCH \
  --url https://app.outlit.ai/api/settings/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slackChannelId": "C0123456789",
  "slackChannelName": "sales-alerts"
}
'

import requests

url = "https://app.outlit.ai/api/settings/report"

payload = {
    "slackChannelId": "C0123456789",
    "slackChannelName": "sales-alerts"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({slackChannelId: 'C0123456789', slackChannelName: 'sales-alerts'})
};

fetch('https://app.outlit.ai/api/settings/report', 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://app.outlit.ai/api/settings/report",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'slackChannelId' => 'C0123456789',
    'slackChannelName' => 'sales-alerts'
  ]),
  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://app.outlit.ai/api/settings/report"

	payload := strings.NewReader("{\n  \"slackChannelId\": \"C0123456789\",\n  \"slackChannelName\": \"sales-alerts\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.outlit.ai/api/settings/report")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slackChannelId\": \"C0123456789\",\n  \"slackChannelName\": \"sales-alerts\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/settings/report")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slackChannelId\": \"C0123456789\",\n  \"slackChannelName\": \"sales-alerts\"\n}"

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

200

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "report": {
        "slackChannelId": "<string>",
        "slackChannelName": "<string>"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Invalid credentials"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

{
  "error": "Internal server error"
}

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 2,
  "error": {
    "message": "<string>",
    "correlationId": "<string>",
    "retryable": true,
    "details": {}
  }
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Body

application/json

slackChannelId · string · required

Required string length: 1 - 191

slackChannelName · string · required

Required string length: 1 - 120

Response

200

application/json

Report settings were updated.

ok · boolean · required

commandId · string · required

Allowed value: "settings.report.update"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes