Access & visibility
Allow meetings.SelectCalendar on your API key.
Acting member required. Send Brigg-Act-As with an approved member account ID. The key supplies permissions; the member selects whose data is used.
The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.
Request fields
Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
idstringRequiredUse the Brigg calendar id inside a connection's calendars array, not the connection id or provider externalId. meetings.ListCalendarConnections.
At least 1 character.
selectedbooleanRequiredWhether this calendar is selected for synchronization.
Response
Returns 200 OK with a JSON body.
idstringRequiredUnique identifier. Use the value returned by a create or list operation.
selectedbooleanRequiredWhether this calendar is selected for synchronization.
Errors & retries
Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.
For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.
| HTTP status | Code | What to do |
|---|---|---|
| 400 | invalid_json |
Send a JSON object with Content-Type: application/json. |
| 400 | invalid_input |
Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | invalid_key |
The workspace API key is missing, invalid or revoked. |
| 403 | forbidden |
Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 404 | not_found |
The requested operation or resource is not available to this credential. |
| 429 | rate_limited |
Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |
Next steps
JSON schemas
Use the complete schemas for validation or client generation.
Full request JSON schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "Use the Brigg calendar id inside a connection's calendars array, not the connection id or provider externalId. [meetings.ListCalendarConnections](/developers/reference/meetings/ListCalendarConnections)."
},
"selected": {
"type": "boolean",
"description": "Whether this calendar is selected for synchronization."
}
},
"required": [
"id",
"selected"
],
"additionalProperties": false,
"examples": [
{
"id": "e_example",
"selected": false
}
]
}Full response JSON schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier. Use the value returned by a create or list operation."
},
"selected": {
"type": "boolean",
"description": "Whether this calendar is selected for synchronization."
}
},
"required": [
"id",
"selected"
],
"additionalProperties": false,
"examples": [
{
"id": "e_example",
"selected": false
}
]
}