Skip to content

Members

MembersSync

Submit group member sync
groups.members.sync.submit(strgroup_id, SyncSubmitParams**kwargs) -> SyncSubmitResponse
POST/v1/groups/{group_id}/members/sync
Get group member sync request
groups.members.sync.retrieve(strrequest_id, SyncRetrieveParams**kwargs) -> SyncRetrieveResponse
GET/v1/groups/{group_id}/members/sync/{request_id}
ModelsExpand Collapse
class SyncSubmitResponse:

Response containing a single group member sync detail resource.

data: Data
accepted_at: datetime
formatdate-time
group_id: str
request_id: str
class SyncRetrieveResponse:

Response containing a single group member sync request detail resource.

data: Data
accepted_at: datetime
formatdate-time
completed_at: Optional[datetime]
formatdate-time
group_id: str
request_id: str
results: Optional[DataResults]
added_group_member_ids: List[str]
failures: List[DataResultsFailure]
operation: Literal["add", "remove"]
  • add - add
  • remove - remove
One of the following:
"add"
"remove"
reason: str
reference_id: str
removed_group_member_ids: List[str]