36360learning
Users

Import a certificate

Changed on

🔑

Required OAuth scope: users:write.

Imports a certificate for a specific user given its unique ID.

post/api/v2/users/{userId}/certificates

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/users/{userId}/certificates
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Path parameters

userIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the user.

Headers

360-api-version'v2.0' required

The version of the API.

Request body multipart/form-data

deliveryDatestring date-time required

The delivery date of the certificate, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

expirationDatestring date-time

The expiration date of the certificate, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

titlestring required

The title of the certificate outline in the platform (internal name of the certificate).

certificateOutlineIdstring ObjectId

The unique ID of the outline of the certificate.

filestring binary required

The file to upload, in the application/pdf format.

Example request

{
  "title": "Certificate of Completion",
  "certificateOutlineId": "507f1f77bcf86cd799439011"
}

Response

Returns the created user's certificate.

deliveryDatestring date-time required

The delivery date of the certificate, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

expirationDatestring date-time

The expiration date of the certificate, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

titlestring required

The title of the certificate outline in the platform (internal name of the certificate).

_idstring ObjectId required

The unique ID of the user certificate.

validityPeriodnumber

The length of time, in months, for which the certificate is valid.

certificateOutlineIdstring ObjectId

The unique ID of the outline of the certificate.

type'external' required

The type of the certificate in the platform.

Example response

{
  "title": "Certificate of Completion",
  "_id": "507f1f77bcf86cd799439011",
  "certificateOutlineId": "507f1f77bcf86cd799439011",
  "type": "external"
}

Changes

  • d827a4a84180Revision changes
    • info

      removed subschema #1: Certificate Already Imported from the response body oneOf list for the response status