Pause/Resume Role (Multiple Roles)
    • PDF

    Pause/Resume Role (Multiple Roles)

    • PDF

    Article summary

    Pause/Resume roles.

    API

    • PUT /roles

    Requests

    Parameters

    ParametersRequirement statusTypeRestrictionsDescription
    activeYBooleanWhether to resume

    Body

    [
      "string"
    ]
    
    ParametersRequirement statusTypeRestrictionsDescription
    bodyYarrayRoleNo list

    Response

    • Response
    Parameter nameRequirement statusTypeDescription
    ProcessResultYArrayProcessing result
    • Response examples - Success
    [
        {
            "id": "roleNo",
            "name": "disableRole",
            "success": true
        },
        {
            "id": "roleNo",
            "name": "disableRole",
            "success": true
        }
    ]
    
    • Response examples - No role to pause and resume
    []
    

    - Response examples - Failure

    [
        {
            "id": "roleNo",
            "name": "disableRole",
            "success": false,
            "message": "An error occurred while changing the role pause status."
        },
        {
            "id": "roleNo",
            "name": "disableRole",
            "success": false,
            "message": "An error occurred while changing the role pause status."
        }
    ]
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.