# Upsert Sharing Group Rules

Upsert Sharing Group Rules

Endpoint: PATCH /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.CascadePermitionsFlag` (any)
    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.Created` (any)
    System controlled field: Date and time the record was created

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

  - `brmObjects.EntityId` (any)
    EntityId

  - `brmObjects.ExternalKey` (any)
    ExternalKey

  - `brmObjects.FilterLogic` (any)
    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.Formula` (any)
    Formula

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

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

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

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

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

  - `externalIDFieldName` (string)
    Enum: "ExternalKey"

## Response 200 fields (application/json):

  - `upsertResponse` (array)

  - `upsertResponse.Id` (any)

  - `upsertResponse.success` (boolean)

  - `upsertResponse.ErrorText` (string)

  - `upsertResponse.ErrorElementField` (string)

  - `upsertResponse.created` (boolean)