| Requires any of the roles: | admin, oauthadmin |
| GET | /Ams/{ClientID}/Ambassadors | Return a list of Ambassadors for the client. | |
|---|---|---|---|
| POST | /Ams/{ClientID}/Ambassadors | Create an Ambassador for the client. | |
| DELETE | /Ams/{ClientID}/Ambassadors/{MemberID} | Delete the Ambassador for the client. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | path | int | No | |
| PageSize | body | int | No | |
| PageNumber | body | int | No | |
| OffSet | body | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AmbassadorsList | form | List<Ambassador> | No | |
| TotalResultsCount | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| HeadShotImage | form | string | No | |
| DisplayName | form | string | No | |
| MemberType | form | string | No | |
| WorkTitle | form | string | No | |
| Rank | form | int | No | |
| LatestActivity | form | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Ams/{ClientID}/Ambassadors HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
MemberID: 0,
PageSize: 0,
PageNumber: 0,
OffSet: 0,
UsingRedis: True,
AppInitTime: 2025-11-16T04:18:28.7981531-05:00,
ServerID: WS-6-143-308,
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-11-16T04:42:09.3885807-05:00,
Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AmbassadorsList:
[
{
Id: 0,
FirstName: String,
LastName: String,
HeadShotImage: String,
DisplayName: String,
MemberType: String,
WorkTitle: String,
Rank: 0,
LatestActivity: 0001-01-01
}
],
TotalResultsCount: 0,
MemberID: 0,
PageSize: 0,
PageNumber: 0,
OffSet: 0,
UsingRedis: True,
AppInitTime: 2025-11-16T04:18:28.7981531-05:00,
ServerID: WS-6-143-308,
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-11-16T04:42:09.3885807-05:00,
Device: Desktop
}