PUT /api/v1/{collection}/{targetId}/customfields
Add a custom field value to a user.
Body:
-
customFieldId: ID of the custom field type. -
value: value for the custom field (existing, or new).-
If the custom field has a type "text", the value should be a string.
-
If the custom field has a type "date", the value should be in the format
MM/DD/YY.
-
If the custom field is restricted (see createCustomField), adding a value outside the list adds it to the list of authorized values.
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
collection |
String | Yes |
Object type of the target. Currently, only users are supported. |
targetId |
String | Yes |
ID of the user. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
values[] |
Array | No | |
values[].customFieldId |
String | No | |
values[].value |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.