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
| Parameter | Type | Value | Required | Notes |
| assessmentId | string | The id of the assessment | Optional | When provided, the request will update the details of the found assessment. |
Query Parameters
| Parameter | Type | Value | Required | Notes |
| externalId | string | The external ID of the assessment | Optional | When provided, the request will update the details of the found assessment. |
Request Body
| Parameter | Type | Value | Required | Notes |
| firstName | string | The assessment taker's first name | Optional* | *If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null. |
| middleName | string | The 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 | string | The assessment taker's last name | Optional* | *If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null. |
| string | The assessment taker's email address | Optional* | *If re-assessing an existing person using an ExternalId or ExternalPersonId, this parameter must be either excluded, empty, or null. | |
| expirationDateTime | string | The expiration date/time of the assessment invitation | Optional |
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 | string | The first name of the person who administered the assessment | Optional |
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 assessment | Optional |
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 assessment | Optional |
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. |
| administeredByPhone | string | The phone number of the person who administered the assessment | Optional |
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 | number | The gender of the assessment taker | Optional |
Valid values: 0 = Unknown 1 = Male 2 = Female |
| personType | string | The type of the person of the assessment taker |
Optional |
Valid values (case-sensitive): Unknown Candidate Other Employee Former Employee |
| resendAssessment | number | Indicates if assessment taker will be notified via email following the request update. | Optional |
Valid values: 0 = Don't Notify 1 = Notify |
| languageLocale | string | The Language the invitation will be sent in | Optional | The default is en-US (English), if no value is provided. The assessment taker can select to complete the assessment in another language. |
| redirectUrl | string | The 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" |
| customFields | array | An array of Custom Fields (Custom Field Name and Assigned Value) | Optional | If a Custom Field Name and/or Assigned Value is not valid, the request will be accepted, but the Custom Field will not be assigned. |
Response
If successful, this method returns a 204 No Content response.
Response Body
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,
"customFields": [
{
"fieldName": "Favorite Color",
"fieldValue": "Blue"
},
{
"fieldName": "Favorite ood",
"fieldValue": "Pizza"
}
]
}
Example Response
© Predictive Index