Email an admin a recap

curl --request POST \
  --url https://api.getprimo.com/admins/recap-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "<string>",
  "subject": "<string>",
  "preheader": "<string>",
  "headline": "<string>",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "dashboardId": "<string>",
  "dashboardName": "<string>",
  "agentId": "<string>",
  "blocks": [
    {
      "type": "numbers",
      "title": "<string>",
      "items": [
        {
          "label": "<string>",
          "value": "<string>",
          "unit": "<string>",
          "delta": "<string>"
        }
      ]
    }
  ],
  "adminId": "<string>"
}
'

import requests

url = "https://api.getprimo.com/admins/recap-email"

payload = {
    "language": "<string>",
    "subject": "<string>",
    "preheader": "<string>",
    "headline": "<string>",
    "period": {
        "from": "2023-12-25",
        "to": "2023-12-25"
    },
    "dashboardId": "<string>",
    "dashboardName": "<string>",
    "agentId": "<string>",
    "blocks": [
        {
            "type": "numbers",
            "title": "<string>",
            "items": [
                {
                    "label": "<string>",
                    "value": "<string>",
                    "unit": "<string>",
                    "delta": "<string>"
                }
            ]
        }
    ],
    "adminId": "<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({
    language: '<string>',
    subject: '<string>',
    preheader: '<string>',
    headline: '<string>',
    period: {from: '2023-12-25', to: '2023-12-25'},
    dashboardId: '<string>',
    dashboardName: '<string>',
    agentId: '<string>',
    blocks: [
      {
        type: 'numbers',
        title: '<string>',
        items: [{label: '<string>', value: '<string>', unit: '<string>', delta: '<string>'}]
      }
    ],
    adminId: '<string>'
  })
};

fetch('https://api.getprimo.com/admins/recap-email', 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://api.getprimo.com/admins/recap-email",
  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([
    'language' => '<string>',
    'subject' => '<string>',
    'preheader' => '<string>',
    'headline' => '<string>',
    'period' => [
        'from' => '2023-12-25',
        'to' => '2023-12-25'
    ],
    'dashboardId' => '<string>',
    'dashboardName' => '<string>',
    'agentId' => '<string>',
    'blocks' => [
        [
                'type' => 'numbers',
                'title' => '<string>',
                'items' => [
                                [
                                                                'label' => '<string>',
                                                                'value' => '<string>',
                                                                'unit' => '<string>',
                                                                'delta' => '<string>'
                                ]
                ]
        ]
    ],
    'adminId' => '<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://api.getprimo.com/admins/recap-email"

	payload := strings.NewReader("{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\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://api.getprimo.com/admins/recap-email")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/admins/recap-email")

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  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\n}"

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

{
  "recipientCount": 0
}

Admins

Email an admin a recap

Send the admins of your company a recap email, by default the digest of one AI dashboard. Primo draws its fixed recap email from the blocks you fill in (numbers, actions, list, breakdown, insight, agents); the title and the footer are added by Primo, and the dashboard button appears when dashboardId is given. It goes to one admin of your own company, the one adminId names (as getAdmins returns them): one recap per admin, never a mailing list. There is no address field and no URL field: the email links to the dashboard (when given) and to your agent only. Every value is plain text, no HTML and no markdown. getAiDashboardData gives the dashboard’s numbers to put in the blocks.

POST

admins

recap-email

curl --request POST \
  --url https://api.getprimo.com/admins/recap-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "language": "<string>",
  "subject": "<string>",
  "preheader": "<string>",
  "headline": "<string>",
  "period": {
    "from": "2023-12-25",
    "to": "2023-12-25"
  },
  "dashboardId": "<string>",
  "dashboardName": "<string>",
  "agentId": "<string>",
  "blocks": [
    {
      "type": "numbers",
      "title": "<string>",
      "items": [
        {
          "label": "<string>",
          "value": "<string>",
          "unit": "<string>",
          "delta": "<string>"
        }
      ]
    }
  ],
  "adminId": "<string>"
}
'

import requests

url = "https://api.getprimo.com/admins/recap-email"

payload = {
    "language": "<string>",
    "subject": "<string>",
    "preheader": "<string>",
    "headline": "<string>",
    "period": {
        "from": "2023-12-25",
        "to": "2023-12-25"
    },
    "dashboardId": "<string>",
    "dashboardName": "<string>",
    "agentId": "<string>",
    "blocks": [
        {
            "type": "numbers",
            "title": "<string>",
            "items": [
                {
                    "label": "<string>",
                    "value": "<string>",
                    "unit": "<string>",
                    "delta": "<string>"
                }
            ]
        }
    ],
    "adminId": "<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({
    language: '<string>',
    subject: '<string>',
    preheader: '<string>',
    headline: '<string>',
    period: {from: '2023-12-25', to: '2023-12-25'},
    dashboardId: '<string>',
    dashboardName: '<string>',
    agentId: '<string>',
    blocks: [
      {
        type: 'numbers',
        title: '<string>',
        items: [{label: '<string>', value: '<string>', unit: '<string>', delta: '<string>'}]
      }
    ],
    adminId: '<string>'
  })
};

fetch('https://api.getprimo.com/admins/recap-email', 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://api.getprimo.com/admins/recap-email",
  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([
    'language' => '<string>',
    'subject' => '<string>',
    'preheader' => '<string>',
    'headline' => '<string>',
    'period' => [
        'from' => '2023-12-25',
        'to' => '2023-12-25'
    ],
    'dashboardId' => '<string>',
    'dashboardName' => '<string>',
    'agentId' => '<string>',
    'blocks' => [
        [
                'type' => 'numbers',
                'title' => '<string>',
                'items' => [
                                [
                                                                'label' => '<string>',
                                                                'value' => '<string>',
                                                                'unit' => '<string>',
                                                                'delta' => '<string>'
                                ]
                ]
        ]
    ],
    'adminId' => '<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://api.getprimo.com/admins/recap-email"

	payload := strings.NewReader("{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\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://api.getprimo.com/admins/recap-email")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getprimo.com/admins/recap-email")

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  \"language\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"preheader\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"period\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\"\n  },\n  \"dashboardId\": \"<string>\",\n  \"dashboardName\": \"<string>\",\n  \"agentId\": \"<string>\",\n  \"blocks\": [\n    {\n      \"type\": \"numbers\",\n      \"title\": \"<string>\",\n      \"items\": [\n        {\n          \"label\": \"<string>\",\n          \"value\": \"<string>\",\n          \"unit\": \"<string>\",\n          \"delta\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"adminId\": \"<string>\"\n}"

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

{
  "recipientCount": 0
}

Key: Write Scope: Company

Authorizations

Authorization

string

header

required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Body

application/json

language

string

required

The language of the text, as a BCP 47 tag: "en", "fr". It formats the dates.

Pattern: ^[a-z]{2}(-[A-Za-z]{2})?$

subject

string

required

The subject of the recap, then the period in a few words: "Today · 3 actions this week".

Required string length: 1 - 60

preheader

string

required

The period's most important change, in one sentence.

Required string length: 1 - 140

headline

string

required

The admin's first name and the period's verdict, in one sentence.

Required string length: 1 - 120

period

object

required

The days the recap covers, as YYYY-MM-DD dates.

Show child attributes

dashboardId

string | null

required

The id of the dashboard the recap is about, as getAiDashboardData returns it; null when the recap is not about one AI dashboard.

Pattern: ^[0-9a-fA-F]{24}$

dashboardName

string | null

required

The dashboard's name as getAiDashboardData returns it, "Today" for the first one; null when the recap is not about one AI dashboard.

Required string length: 1 - 80

agentId

string

required

Your own agent id, as your instructions give it.

Pattern: ^[A-Za-z0-9-]{1,64}$

blocks

object[]

required

1 to 5 blocks, in display order. Values only: no HTML, no markup, no URL.

Required array length: 1 - 5 elements

Show child attributes

adminId

string

required

The one admin to email, as returned by getAdmins (an employee id or an external userId).

Minimum string length: 1

Response

default - application/json

recipientCount

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

Get started

API Reference

Email an admin a recap

Authorizations

Body

Response