Contents x
    Update a group
    • 17 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update a group

    • Updated on 17 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Users

    PATCH /groups/{externalId}
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Body Parameters

    Parameters indicated with a * are mandatory

    Name
    Data Type
    		Description
    ExternalId*string (64)External Id, shown as "Organisation ID" in Cirrus Edit Hierarchy screen.. Should be unique. Alpha-Numeric.
    ParentExternalIdstring (64)ExternalId (OrganisationID) of parent group. By default(null or empty) it uses root hierarchy.
    SynchronizationKeystring guid (64)Deprecated: SynchronizationKey is no longer in use (and only kept for backward compatibility) example: 0c824cc1-8294-4857-81cb-8327d83df554
    Title*string (100)example: cirrus_user@gmail.com
    IsArchivedbooleanAllows you to archive a hierarchy by setting the value on 'true'
    AllowRelationshipWithSchedulesboolean"Allow relationship with Scheduled assessments" in Cirrus Edit Hierarchy screen. This allows users belonging to this hierarchy to schedule assessments belonging to this hierarchy. True by default.
    IsOrganizationbooleanMark hierarchy as organisation, shown as "Root level" in Cirrus Edit Hierarchy screen. False by default.
    "Root level"=isOrganization, "Organisation ID"=ExternalId

    Confusingly: The "Organisation ID" is the ExternalId of a Hierarchy. "Root level" in Cirrus Edit Hierarchy screen is called isOrganization in the API.

    Sample Request URL

    https://api.cirrusplatform.com/api/v1/integrations/groups/NewGroup

    Sample body

    {
    "ExternalId": "SAMPLE",
    "ParentExternalId": "",
    "Title": "Sample Hierarchy",
    "IsArchived": false,
    "AllowRelationshipWithSchedules": true,
    "IsOrganization": false
}

    Sample Response

    {
    "Content": {
        "ExternalId": "SAMPLE"
    },
    "Success": true,
    "Errors": null
}

    Response codes

    CodeDescription
    200Successful operation
    403Not allowed to use external API
    400Possible errors:
    Request body can not be null or empty
    External id must not be null or empty
    ExternalId must be alpha-numeric(a-z 0-9)
    ExternalId must be less than 500 symbols
    ParentExternalId must be less than 500 symbols
    Group cannot be parent for itself
    SynchronizationKey must be valid GUID
    Title must not be null or empty
    Title must be less than 500 symbols
    ExternalId [{externalId}] is used
    Parent group with ParentExternalId [{parentExternalId}] is not found
    Organization below or above other organization is not allowed
    SynchronizationKey [{synchronizationKey}] is used
    500Internal server error
    Was this article helpful?
    What's Next