Assign a certification, course or lesson

POST/v1/organization/{orgId}/learning/assignments/create

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

Assigns already-published training to the whole team or named teammates and messages each of them. Requires write:learning. Also at POST /v1/learning/assignments/create.

Request example

cURL

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "targetKind": "certification",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience": {
    "allTeam": true,
    "userIds": [
      123
    ]
  },
  "dueInDays": 1,
  "required": true,
  "slackChannelId": "<string>"
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "targetKind": "certification",
    "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "audience": {
      "allTeam": true,
      "userIds": [
        123
      ]
    },
    "dueInDays": 1,
    "required": true,
    "slackChannelId": "<string>"
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "targetKind": "certification",
        "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "audience": {
            "allTeam": True,
            "userIds": [
                123
            ]
        },
        "dueInDays": 1,
        "required": True,
        "slackChannelId": "<string>"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
  "targetKind": "certification",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience": {
    "allTeam": true,
    "userIds": [
      123
    ]
  },
  "dueInDays": 1,
  "required": true,
  "slackChannelId": "<string>"
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create", strings.NewReader(`{
  "targetKind": "certification",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience": {
    "allTeam": true,
    "userIds": [
      123
    ]
  },
  "dueInDays": 1,
  "required": true,
  "slackChannelId": "<string>"
}`))
  req.Header.Add("x-access-token", "<api-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))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/learning/assignments/create"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"targetKind\": \"certification\",\n  \"targetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"audience\": {\n    \"allTeam\": true,\n    \"userIds\": [\n      123\n    ]\n  },\n  \"dueInDays\": 1,\n  \"required\": true,\n  \"slackChannelId\": \"<string>\"\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters

orgId*

Body application/json

{ "targetKind": "certification", "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "audience": { "allTeam": true, "userIds": [ 123 ] }, "dueInDays": 1, "required": true, "slackChannelId": "<string>" }

POST

Send request

Authorizations

• x-access-tokenstringheader

  Organization API token. Generate from Organization Settings → API Tokens.

• AuthorizationBearer <token>headeror

  OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

• orgIdstringpathrequired

  Your organization ID. Any other organization returns 404.

Request body

application/jsonrequired

• targetKindstringrequired

  series is a course.

  Allowed values

  "certification", "series", "lesson"

• targetIdstring<uuid>required
• audienceobjectrequired
  Show child attributes

  • allTeamboolean
  • userIdsinteger[]
• dueInDaysinteger | null

  Minimum

  1

  Maximum

  365

• requiredboolean
• slackChannelIdstring

  Max length

  32

Example

{
  "targetKind": "certification",
  "targetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audience": {
    "allTeam": true,
    "userIds": [
      123
    ]
  },
  "dueInDays": 1,
  "required": true,
  "slackChannelId": "<string>"
}

Responses

201

Assigned; payload.assignment and payload.delivery (who was messaged, and how).

403

• SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
• FORBIDDEN — Learning is not on for the organization, or the token's user lacks the Lessons permission.