API/Member/DemographicSync
- Seth Petry-Johnson
Triggers the Demographic Synchronization process. Allows for periodic synchronization without relying on users to actually log in through SSO.
Workflow Attribute names are case-sensitive. Attribute names must be capitalized in the payload exactly as they are configured in LearningBuilder.
Overview
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
POST /API/Member/DemographicSync
args={list of Unique Ids}Form Parameter | Description |
|---|---|
| Required: List of Unique Identifiers to synchronize |
1 You must provide either TaskGroupId or TaskGroupTitle, but not both.
Response
If successful:
{
"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:
{
"success": false,
"errors": [array of strings]
}