Boolean

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
checked (required)	`boolean`	true \| false

A complete request would be:

{ 
  "custom_attribute_key": "13e0eb0e", 
  "checked": "true"
}

Short text

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
value (required)	`string`	The candidate's response (maximum 128 characters)

A complete request would be:

{ 
  "custom_attribute_key": "13e0eb0e", 
  "value": "This is a test"
}

Free text

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
value (required)	`text`	The candidate's response

A complete request would be:

{ 
  "custom_attribute_key": "13e0eb0e", 
  "value": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreat."
}

Numeric

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
value (required)	`integer`	The value may be an integer or floating point number (use '.' as decimal point separator)

A complete request would be:

{
    "custom_attribute_key": "5331",
    "value": 1234
}

File (base64 encoded)

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
file/name (required)	`string`	The file name
file/data (required)	`string`	The candidate’s file encoded in base64

A complete request would be:

{
    "custom_attribute_key": "52f",
    "file": {
        "name": "updated_custom_attribute_file.pdf",
        "data": "d29ya2FibGUgcnVsZXoK"
    }
}

File (URL)

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
file_url (required)	`string`	A URL pointing to the candidate’s answer

A complete request would be:

{
    "custom_attribute_key": "52f",
    "file_url": "https://somedomain.com/abcdefgh.jpg"
}

Date

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute identifier
date (required)	`string`	The date in ISO 8601 format (i.e. "2017-05-22")

A complete request would be:

{
    "custom_attribute_key": "52d",
    "date": "1970-01-01"
}

Dropdown

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
choices (required)	`array of strings`	[choices_ids][choices_ids]. Provide only one selected choice

A complete request would be:

{
    "custom_attribute_key": "52e",
    "choices": ["1228"]
}

Multiple choice

key	type	description
custom_attribute_key (required)	`string`	The unique custom attribute key
choices (required)	`array of strings`	[choices_ids][choices_ids]. For single answer questions provide only one selected choice

A complete request would be:

{
    "custom_attribute_key": "534",
    "choices": ["122d", "122e"]
}

201201

401401

404404