Skip to navigation

Update group access sources

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
group_ingestion_sourceslist of objectsOptional
Connectors from which email groups are ingested. The list is replaced as a whole on update.
common_group_filterslist of objectsOptional
Filters applied to groups from all ingestion sources.

Response

The updated group access sources, at its new version
group_ingestion_sourceslist of objectsOptional
Connectors from which email groups are ingested. The list is replaced as a whole on update.
joining_keyenumOptional

Attribute used to match copies of the same group across systems, mainly for Microsoft groups (AD, Exchange, O365). One of EMAIL or EXTERNAL_ID; EMAIL is most common. Cannot be changed after creation.

Allowed values:
common_group_filterslist of objectsOptional
Filters applied to groups from all ingestion sources.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error