Versions Compared

Version Old Version 3 New Version 4
Changes made by

Seth Petry-Johnson

Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

...

titleSummary

Triggers the /wiki/spaces/DOCS/pages/418873400 process. Allows for periodic synchronization without relying on users to actually log in through SSO.

Overview

...

TODO

Requirements

Filter by label (Content by label)
cqllabel = "api-demo-sync"

...

hiddentrue

...

Accepts as input a list of Unique Identifiers that identify the Members to update.

Adds those identifiers to a queue for processing in the background.

Calling the API

Authentication

Requires an API Key with the DEMOGRAPHIC_SYNC permission.

Request

Code Block
POST /API/Member/DemographicSync

args={list of Unique Ids}

Form Parameter

Description

args

Required: List of Unique Identifiers to synchronize

Info

1 You must provide either TaskGroupId or TaskGroupTitle, but not both.

Response

If successful:

Code Block
languagejson
{
  "success": true,
}

A successful response indicates that the Unique Ids were added to the processing queue. It does NOT indicate whether those IDs were successfully synchronized or not.

If unsuccessful:

Code Block
languagejson
{
  "success": false,
  "errors": [array of strings]
}