Requires any of the roles: | admin, oauthadmin |
GET | /Ams/{ClientID}/EmailSenderInfo | Return the list of Admin Email Sender information. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
blnReturnAll | query | bool | No | |
blnIncludeDefault | query | bool | 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 |
---|---|---|---|---|
EmailSenderList | form | List<EmailSenderInfo> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Address | form | string | No | |
Display | form | string | No | |
Status | form | Status | No | |
IsDefault | form | bool | 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.
GET /Ams/{ClientID}/EmailSenderInfo HTTP/1.1 Host: ws.yourmembership.com Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { EmailSenderList: [ { Address: String, Display: String, Status: Undefined, IsDefault: False } ], blnReturnAll: False, blnIncludeDefault: False, UsingRedis: True, AppInitTime: 2025-01-15T06:16:03.6874989-05:00, ServerID: WS-5-99-907, 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-01-15T08:45:09.0234597-05:00, Device: Desktop }