Account Owner, Account Administrators, Department Administrators, Publishers, or custom roles.
Department Administrators, Publishers, and users with a custom role can add users only to the departments they manage and their sub-departments.
Parameter | Description |
---|---|
Authorization (required) | Access token. You can obtain a token by making a request. |
Parameter | Description |
---|---|
userFieldInfo | An array with data about the user profile field |
userFieldInfoId | The ID of the profile field |
label | The name of the profile field |
type | The field type. Possible values:
|
isUnique | The parameter shows if the field is unique. Possible values: 0 — not unique (false) |
isRequired | The parameter shows if the field is required. Possible values: 0 — is optional (false) |
orderPriority | The ordinal number of the field – the count starts from 0. For example, for the first field in the list, the parameter orderPriority=0, etc. |
values [] (optional) | An array with the data of the fields from the list. For example, the country field type includes a list of countries. |
field | The dropdown list item. Each field contains both the name field and the value field. |
Code | Text | Description |
---|---|---|
200 | Ok | The request has been processed successfully. |
400 | Bad Request | A request error. |
401 | Unauthorized | An authorization error. |
403 | Permission denied | The user doesn't have enough permissions to complete the request. |
GET /user/profile/fields https/1.1 Host: api-learn.ispringlearn.com Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE |
https/1.1 200 OK Connection: close <?xml version="1.0" encoding="UTF-8"?> <response> <userFieldInfo> <userFieldInfoId>USER_DEFINED_FIELD3</userFieldInfoId> <name>string</name> <label>string</label> <type>string</type> <isUnique>true</isUnique> <isRequired>true</isRequired> <orderPriority>0</orderPriority> <values> <field> <name>string</name> <value>string</value> </field> </values> </userFieldInfo> </response> |