It is mandatory that the fields with isRequired set to true be passed in as part of the request.
Example: Say you have 2 person fields on an account "Contact Number" and "Certifications" where isRequired is set to true on "Contact Number".
FieldDefinition Example Response - GET PersonFields (/api/v{version}/accounts/{id}/person-fields)
[
If you only send in the following your request will result in a 400.
[
Validation
Single List Selection: A list where only 1 value can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Multi List Selection: A list where 0 or more values can be selected. When creating the list, each value should be between 1 and 250 non-empty characters.
Text: Min length: 0. Max length: 250
Date selector: Format: dd/MM/yyyy
Other: Max length: 2400
Checkbox: Accepted values: true or false
Currency: ^[0-9]{0,15}(\.[0-9]{0,2})?$
Currency should be greater or equal to zero, starts with 0 to 15 digits of 0-9 then optionally followed by . with 0 to 2 digits of 0-9
Phone: ^\+[1-9]\d{10,14}$
Phone starts with a + followed by 11 to 15 digits of 0-9 where the first digit is not 0
Permissions
Person: Write
HourlyProfile: Write
Private: Read
Finance: Read
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
200OK
204No Content (success)
400Bad Request
401Unauthorized
403Forbidden - User doesn't have permissions on this resource, or the account or person couldn't be found
422Unprocessable Entity