Skip to content

Sync

Submit group member sync
POST/v1/groups/{group_id}/members/sync
Get group member sync request
GET/v1/groups/{group_id}/members/sync/{request_id}
ModelsExpand Collapse
SyncSubmitResponse { data }

Response containing a single group member sync detail resource.

data: { accepted_at, group_id, request_id }
accepted_at: string
formatdate-time
group_id: string
request_id: string
SyncRetrieveResponse { data }

Response containing a single group member sync request detail resource.

data: { accepted_at, completed_at, group_id, 2 more }
accepted_at: string
formatdate-time
completed_at: string
formatdate-time
group_id: string
request_id: string
results: { added_group_member_ids, failures, removed_group_member_ids }
added_group_member_ids: array of string
failures: array of { operation, reason, reference_id }
operation: "add" or "remove"
  • add - add
  • remove - remove
One of the following:
"add"
"remove"
reason: string
reference_id: string
removed_group_member_ids: array of string