YM REST Services

<back to all web services

PeopleBulkDetachRequest

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/PeopleBulkDetachDetach multiple sub accounts from master account
PeopleBulkDetachRequest Parameters:
NameParameterData TypeRequiredDescription
DetachRequestsbodyList<PeopleBulkDetach>No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PeopleBulkDetach Parameters:
NameParameterData TypeRequiredDescription
MasterIdformstringNo
SubAccountIdsformList<string>No
PeopleBulkDetachResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformstringNo
flagformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/PeopleBulkDetach HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DetachRequests":[{"MasterId":"String","SubAccountIds":["String"]}],"UsingRedis":true,"AppInitTime":"2025-09-13T11:49:19.1398963-04:00","ServerID":"WS-5-39-512","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-09-13T13:57:58.3113254-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Status":"String","flag":false}