PATCH /behavioralassessments

Updates an existing assessment with the input values specified.

Note: You must provide a path parameter or a query parameter to find the assessment you are updating. You are not able to provide both so one should be provided.  Only the values which are to be updated need to be included in the Request Body, all others can be excluded.

Request

PATCH https://pi.predictiveindex.com/api/v1/behavioralassessments/<assessmentId>

Path Parameters

ParameterTypeValueRequiredNotes
assessmentIdstringThe id of the assessmentOptionalWhen provided, the request will update the details of the found assessment.

Query Parameters

ParameterTypeValueRequiredNotes
externalIdstringThe external ID of the assessmentOptionalWhen provided, the request will update the details of the found assessment.

Request Body

ParameterTypeValueRequiredNotes
firstName stringThe assessment taker's first nameOptional**If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null.
middleName stringThe assessment taker's middle name Optional**If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null.
lastName stringThe assessment taker's last nameOptional**If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null.
email stringThe assessment taker's email addressOptional**If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null.
expirationDateTimestringThe expiration date/time of the assessment invitationOptional

The date and time must be in UTC using the ISO 8601 standard and must be in the future. This parameter can be down to seven (7) decimal places of precision.

Examples: "2015-01-31" or "2015-01-31T23:59:59.0123456Z"

administeredByFirstName stringThe first name of the person who administered the assessmentOptional

If this parameter is included, the following are also required: administeredByLastName, administeredByEmail, administeredByPhone

If these parameters are not included, the API User's account details will be used.

administeredByLastName string The last name of the person who administered the assessmentOptional

If this parameter is included, the following are also required: administeredByFirstName, administeredByEmail, administeredByPhone.

If these parameters are not included, the API User's account details will be used.

administeredByEmail string The email address of the person who administered the assessmentOptional

If this parameter is included, the following are also required: administeredByFirstName, administeredByLastName, administeredByPhone.

If these parameters are not included, the API User's account details will be used.

administeredByPhonestringThe phone number of the person who administered the assessmentOptional

If this parameter is included, the following are also required: administeredByFirstName, administeredByLastName, administeredByEmail.

If these parameters are not included, the API User's account details will be used.

gender numberThe gender of the assessment takerOptional 

Valid values:

0 = Unknown

1 = Male

2 = Female

personTypestringThe type of the person of the assessment taker

Optional

Valid values (case-sensitive):

Unknown

Candidate

Other

Employee

Former Employee

resendAssessmentnumberIndicates if assessment taker will be notified via email following the request update.Optional

Valid values:

0 = Don't Notify

1 = Notify

languageLocalestringThe Language the invitation will be sent inOptionalThe default is en-US (English), if no value is provided.  The assessment taker can select to complete the assessment in another language. 
redirectUrlstringThe URL the assessment taker will be directed to after the assessment is completed.Optional

This URL must be the full path, include the protocol.

Valid: "http://www.predictiveindex.com"

Not valid: "www.predictiveindex.com"






Response

If successful, this method returns a 204 No Content response.

Response Body

N/A

Example Request

curl -X PATCH https://pi.predictiveindex.com/api/v1/behavioralassessments \

   -H "api-key: 12345678-ABCD-EFGH-1234-ABCDEFGH1234" \

   -H "Content-Type: application/json" -d @body.json

Example Request Body (@body.json)

{

   "expirationDateTime": "2017-12-31",

   "gender": 1,

   "resendAssessment": 1

}

Example Response

N/A