Create a custom attribute
Create a new custom attribute by using this method.
Please log in to see full path URL. Learn why.
post
/people/2/customAttributes
Authorizations:
Scopes:
Request rate limit:
5 requests / second (per account)
Request Body schema:
application/json
collapse all -
| dataType | string Enum: "STRING" "DECIMAL" "INTEGER" "BOOLEAN" "DATE" "DATE_TIME" "LIST_OF_OBJECTS" Custom attribute type. | ||
| name | string Custom attribute name, 256 characters max. Invalid characters: | ||
| objectSchema | object Object schema for | ||
| |||
Responses
default
successful response
400
Bad Request
401
Unauthorized
403
Forbidden
429
Too Many Requests
4XX
Error responses
500
Internal Server Error
5XX
Error responses
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Example
Create custom attribute.
Copy
Collapse all {- "name": "Contract Expiry Date",
- "dataType": "DATE"
}Response samples
- default
- 400
- 401
- 403
- 429
- 4XX
- 500
- 5XX
Content type
application/json
Example
Response for create custom attribute request.
Copy
Collapse all {- "createdAt": "2019-02-25T12:46:06",
- "modifiedAt": "2019-02-25T12:46:06",
- "name": "Contract Expiry Date",
- "dataType": "DATE"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See
Service status'%3E %3Cpath d='M11.9047 8.47667L19.3513 0H17.5873L11.1187 7.35867L5.956 0H0L7.80867 11.1287L0 20.0167H1.764L8.59067 12.244L14.044 20.0167H20M2.40067 1.30267H5.11067L17.586 18.778H14.8753' fill='%23424B5C'/%3E %3C/g%3E %3Cdefs%3E %3CclipPath id='clip0_3438_1744'%3E %3Crect width='20' height='20.0167' fill='white'/%3E %3C/clipPath%3E %3C/defs%3E %3C/svg%3E)
