To list all profiles from your instance:
method: GET
URL: /profiles.json
RETURN:
{ "profiles":[PROFILES INFORMATION], "profile_kinds": { [PROFILE KINDS INFORMATION] }, "avatars":[AVATARS INFORMATION] }
You can also create and update user profiles.
To create a profile
method: POST
URL: /management/profiles.json
PARAMETERS:
{ "profile": { "name": "PROFILE NAME", "profile_kind": [PROFILE_KIND_ID], "pin_active": true/false, "parental_control_pin": "PIN", "avatar": "AVATAR_CODE" } } Valid avatar codes: ['yeti', 'candy', 'crab', 'gamer', 'happy', 'lollypop', 'planet', 'robot', 'rocket', 'smile', 'surprised', 'ufo'] RETURN: { "status": true/false }
To update a profile
method: PUT/PATCH
URL: /management/profiles/[PROFILE ID].json
PARAMETERS:
{ "profile": { "name": "PROFILE NAME", "profile_kind": PROFILE_KIND_ID, "pin_active": true/false, "parental_control_pin": "PIN", "avatar": "AVATAR_CODE" } } Valid avatar codes: ['yeti', 'candy', 'crab', 'gamer', 'happy', 'lollypop', 'planet', 'robot', 'rocket', 'smile', 'surprised', 'ufo'] RETURN: { "status": true/false }
To delete a profile
method: DELETE
URL: /management/profiles/[PROFILE ID].json
PARAMETERS: { "profile": { "parental_control_pin": "PIN" } } RETURN: { "status": true/false }