Team Members

Update a Team Member

Changed on

Update a TeamMember using this action. It requires a JSON object containing a TeamMember.

Important

  • Organization Admin cannot be created or updated through the API.
  • To assign a Department Admin or Developer your account must be on the Connect/Growth Plan.

The department_permissions array replaces the TeamMember's entire permission set. A Department present in the array is created or updated; a Department omitted from the array has its permission removed, if your API key is authorized to remove it.

Which TeamMembers you can update depends on the type of API key you use:

Access LevelAccount-wide keyDepartment-specific key
Team MemberAny Department in the accountIts own Department only
Department AdminAny Department in the accountNot permitted
DeveloperAny Department in the accountNot permitted
Organization AdminNot permittedNot permitted

Permitted values by access_level.

<table> <thead> <tr><th>Field</th><th>Team Member</th><th colspan="2">Department Admin<sup>&ast;</sup></th><th>Developer<sup>&ast;</sup></th></tr> </thead> <tbody> <tr><td><code>access_level</code></td><td><code>team_member</code></td><td colspan="2"><code>department_admin</code></td><td><code>developer</code></td></tr> <tr><td><code>role</code></td><td><code>editor</code><br><code>credential_issuer</code><br><code>viewer</code></td><td colspan="2"><code>editor</code></td><td><code>viewer</code></td></tr> <tr><td><code>api</code></td><td>NA</td><td><code>false</code></td><td><code>true</code></td><td><code>true</code></td></tr> <tr><td><code>designs</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>emails</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>credential_attributes</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>analytics</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>settings</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>pathways</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>team</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>analytics_email</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>manage_dept_admins_and_devs</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>groups</code></td><td>Array of Group IDs to limit access to</td><td colspan="2">NA (All groups allowed)</td><td>NA (All groups allowed)</td></tr> </tbody> </table>

NA - Not Applicable, can be omitted.<br><sup>*</sup> Only available on Connect/Growth Plan.

put/v1/team_members/{id}

Request

  • Base URL
    https://api.accredible.com
  • URL
    https://api.accredible.com/v1/team_members/{id}
  • Auth
    API key in header Authorization

Request body

idnumber required

The ID of the TeamMember to update.

namestring

The name of the TeamMember user. A blank value leaves the existing name unchanged.

Response

OK

Changes

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the new optional request property ///

    • info

      added the media type application/json for the response with the status