# Save Sharing Group Rules

Save Sharing Group Rules

Endpoint: POST /rest/2.0/SHARING_GROUP_RULE
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.ExternalKey` (string)
    ExternalKey

  - `brmObjects.Id` (string, required)
    Sharing Group Rule ID

  - `brmObjects.SharingGroupId` (string)
    Sharing Group ID

  - `brmObjects.EntityId` (integer)
    EntityId

  - `brmObjects.CascadePermitionsFlag` (string)
    Cascade Permitions Flag: Applicable for entities with child objects. When this is checked, the permission will also apply to records in the child object.

  - `brmObjects.FilterLogic` (string)
    Filter Logic: This will indicate how the entity access rows will be evaluated. The AND and OR operators along with parenthesis for grouping can be used here.

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.RuleCriteria` (string)
    Rule Action Criteria

  - `brmObjects.Formula` (string)
    Formula

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.ExternalKey` (string)
    ExternalKey

  - `retrieveResponse.Id` (string)
    Sharing Group Rule ID

  - `retrieveResponse.SharingGroupId` (string)
    Sharing Group ID

  - `retrieveResponse.EntityId` (integer)
    EntityId

  - `retrieveResponse.CascadePermitionsFlag` (string)
    Cascade Permitions Flag: Applicable for entities with child objects. When this is checked, the permission will also apply to records in the child object.

  - `retrieveResponse.FilterLogic` (string)
    Filter Logic: This will indicate how the entity access rows will be evaluated. The AND and OR operators along with parenthesis for grouping can be used here.

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.RuleCriteria` (string)
    Rule Action Criteria

  - `retrieveResponse.Formula` (string)
    Formula

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error