Create training assignments.

Create training assignments. Existing assignments will remain unchanged.

Rate limit: 10 requests/sec (learn more about rate limits here).

To use this endpoint, select Write Training Assignments under the Training Assignments category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

POST /training-assignments

Create training assignments.

cURL

curl --request POST \
  --url https://api.samsara.com/training-assignments \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "course": {
        "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
        "revisionId": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7"
      },
      "createdAtTime": "2019-06-13T19:08:25Z",
      "createdById": "user-4392",
      "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
      "isExistingAssignment": true,
      "learner": {
        "id": "938172",
        "type": "driver"
      },
      "dueAtTime": "2019-06-13T19:08:25Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

courseId · string · required

String for the course ID.

dueAtTime · string · required

Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.

learnerIds · string[] · required

Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: learnerIds=driver-281474,driver-46282156

Response

200

application/json

OK response.

data · object[] · required

List of created training assignments.

Show child attributes