MOmonta
Operator Lists

Trigger a sync of a filter list

Changed on

Queues a reconcile of a FILTER-source list against its filter definition and returns the pending run to poll. Required scope: operator-lists:write </br>Organization authorization: supported

post/api/v1/operator-lists/{listId}/sync

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/operator-lists/{listId}/sync
  • Auth
    HTTP bearer

Path parameters

listIdinteger required

Response

Sync queued; the pending run is returned

idinteger required

Id of the sync run.

listIdinteger required

Id of the list this run reconciled.

status'PENDING' | 'RUNNING' | 'COMPLETED' | 'FAILED' required

Status of the run.

trigger'MANUAL' | 'AUTO' | 'CREATED' | 'UPDATED' required

What triggered the run.

matchedCountinteger nullable

How many entities the filter matched. Null until the run finishes.

addedCountinteger nullable

How many members were added. Null until the run finishes.

removedCountinteger nullable

How many members were removed. Null until the run finishes.

proposedCountinteger nullable

How many changes were proposed. Null until the run finishes.

excludedSkippedCountinteger nullable

How many candidates were skipped because they are excluded. Null until the run finishes.

errorMessagestring nullable

Error message when the run failed.

startedAtstring nullable

When the run started (ISO-8601).

finishedAtstring nullable

When the run finished (ISO-8601).

createdAtstring nullable

When the run was created (ISO-8601).

updatedAtstring nullable

When the run was last updated (ISO-8601).

entityIdsByOutcomeobject nullable

The charge-point ids behind each outcome tally, keyed by outcome. Only returned by the single-run endpoint.

Example response

{
  "id": 1,
  "listId": 42,
  "status": "COMPLETED",
  "trigger": "MANUAL",
  "matchedCount": 120,
  "addedCount": 5,
  "removedCount": 2,
  "errorMessage": "Search is unavailable; please retry.",
  "entityIdsByOutcome": {
    "matched": [
      1,
      2,
      3
    ],
    "added": [
      3
    ]
  }
}

Changes