Skip to main content
POST
/
core.v1.GroupService
/
UpdateGroup
cURL
curl -X POST "https://api.joinformal.com/core.v1.GroupService/UpdateGroup" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "group": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "dsyncGroupId": "<string>",
    "terminationProtection": true,
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z"
  }
}

Authorizations

X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal dashboard.

Body

application/json
id
string
Minimum length: 1
name
string | null
description
string | null
terminationProtection
boolean | null

Response

Success

group
object