API ReferenceSchedule groups

Update schedule group

Rename an existing schedule group.

PATCH
/v1/schedule_groups/{schedule_group_id}

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

schedule_group_id*string

Schedule group ID

Match^sgrp_\w{12}$

Request Body

application/json

Schedule group params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for updating a schedule group

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/schedule_groups/string" \  -H "Content-Type: application/json" \  -d '{    "name": "Intake"  }'
{  "data": {    "id": "sgrp_a1b2c3d4e5f6",    "name": "Orientations",    "object": "schedule_group"  }}