assessment
package

Create an assessment package

Changed on
post/assessment/{connection_id}/package

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/assessment/{connection_id}/package
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Request body

idstring

Unique identifier for the assessment package

created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring

Workspace ID that this package belongs to (reference to KmsSpace)

connection_idstring

Connection ID that this package belongs to

integration_typesstring[]

Integration types that support this package

namestring

Name of the assessment package

type'SKILLS_TEST' | 'BEHAVIORAL_ASSESSMENT' | 'VIDEO_INTERVIEW' | 'BACKGROUND_CHECK' | 'REFERENCE_CHECK' | 'OTHER' required
aliasesstring[]

Alternative namesidentifiers for this package

tagsstring[]

Category tags (e.g., "Assessment", "Background Check")

descriptionstring

Detailed description

has_redirect_urlboolean

Whether provider redirects user to complete assessment

has_target_urlboolean

Where provider redirects user after completion

needs_ip_addressboolean

Whether IP address is required

max_scorenumber

Maximum possible score if this assessment returns a score

info_urlstring

URL to find additional information about this package

rawobject

Response

Successful

idstring

Unique identifier for the assessment package

created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

workspace_idstring

Workspace ID that this package belongs to (reference to KmsSpace)

connection_idstring

Connection ID that this package belongs to

integration_typesstring[]

Integration types that support this package

namestring

Name of the assessment package

type'SKILLS_TEST' | 'BEHAVIORAL_ASSESSMENT' | 'VIDEO_INTERVIEW' | 'BACKGROUND_CHECK' | 'REFERENCE_CHECK' | 'OTHER' required
aliasesstring[]

Alternative namesidentifiers for this package

tagsstring[]

Category tags (e.g., "Assessment", "Background Check")

descriptionstring

Detailed description

has_redirect_urlboolean

Whether provider redirects user to complete assessment

has_target_urlboolean

Where provider redirects user after completion

needs_ip_addressboolean

Whether IP address is required

max_scorenumber

Maximum possible score if this assessment returns a score

info_urlstring

URL to find additional information about this package

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status