Ams

Create relationships between the supplied Member ID and Group Code.

There are three types of relationships that may be created for a group: Member, Administrator and Representative. When adding a member to a group as a member, 'IsPrimaryGroup' should be specified. When adding a member to a group as a 'Representative', a Title should be specified in the 'AddGroupRepTitle' argument. If the title does not exist, it will be created automatically.

post/Ams/{ClientID}/MemberGroups

Request

Base URL
https://ws.yourmembership.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/MemberGroups/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ClientIDinteger required

Request body application/x-www-form-urlencoded

PageNumberinteger

PageSizeinteger

OffSetinteger

Status'None' | 'Joined' | 'Pending' | 'NotJoined' | 'JoinedOrPending'

GroupTypeIdinteger

SearchTermstring

AddAsMemberboolean

IsPrimaryGroupboolean

AddAsGroupAdminboolean

AddGroupRepTitlestring

RemoveAsMemberboolean

RemoveAsGroupAdminboolean

RemoveGroupRepTitlestring

IDinteger

GroupCodestring

MemberIDinteger

ResponseStatusstring

BypassCacheboolean

DateCachedstring date-time

Devicestring

Response

Success