Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Groups

Members

MembersSync

Submit group member sync
client.groups.members.sync.submit(stringgroupID, SyncSubmitParams { members } body, RequestOptionsoptions?): SyncSubmitResponse { data }
POST/v1/groups/{group_id}/members/sync
Get group member sync request
client.groups.members.sync.retrieve(stringrequestID, SyncRetrieveParams { group_id } params, RequestOptionsoptions?): SyncRetrieveResponse { data }
GET/v1/groups/{group_id}/members/sync/{request_id}
ModelsExpand Collapse
SyncSubmitResponse { data }

Response containing a single group member sync detail resource.

data: 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: Data { accepted_at, completed_at, group_id, 2 more }
accepted_at: string
formatdate-time
completed_at: string | null
formatdate-time
group_id: string
request_id: string
results: Results | null
added_group_member_ids: Array<string>
failures: Array<Failure>
operation: "add" | "remove"
  • add - add
  • remove - remove
One of the following:
"add"
"remove"
reason: string
reference_id: string
removed_group_member_ids: Array<string>