Requires any of the roles: | admin, oauthadmin | Requires the permission: | CanAdminMembers |
PUT | /Ams/{ClientID}/MembershipRenewalReminder | Update Membership Renewal Reminders Details for given Membership Id. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
membershipRenewalReminder | body | MembershipRenewalReminder | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MemberID | form | int | 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 |
---|---|---|---|---|
Id | form | int | No | Membership Id |
AdvanceRenewalReminder | form | List<AdvanceRenewalReminder> | No | Advance Renewal Reminder configuration for Reminder 1 , 2 and 3 |
AdvanceMembershipRenewalDays | form | int? | No | How many days in advance can memberships be renewed? |
UseCustomLastDayExpireNotification | form | bool? | No | Use custom reminder email content for last day renewal reminder |
UseCustomPostExpireNotication | form | bool? | No | Use custom reminder email content for post expiration renewal reminder |
CustomLastDaySubject | form | string | No | Custom subject for last day renewal reminder |
CustomLastDayNotificationBody | form | string | No | Custom message for last day renewal reminder |
CustomPostExpireSubject | form | string | No | Custom subject for post expiration renewal reminder |
CustomPostExpireNotificationBody | form | string | No | Custom message for post expiration renewal reminder |
MembershipName | form | string | No | Membership name |
PostExpireMembershipRenewalDays | form | int? | No | How many days after should a reminder be sent? |
SendPostExpireMembershipReminder | form | bool? | No | Send a reminder via email for post expiration renewal reminder |
SendLastDayExpireMembershipReminder | form | bool? | No | Send a reminder via email for last day renewal reminder |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReminderType | form | int | No | Type of advance renewal reminder |
SendMembershipReminder | form | bool? | No | Send a reminder via email for advanced renewal reminder |
AdvanceMembershipRenewalReminderDays | form | int? | No | How many days in advance should a reminder be sent? |
UseCustomPreExpireNotification | form | bool? | No | Use custom reminder email content for advanced renewal reminder |
CustomPreExpireSubject | form | string | No | Custom subject for advanced renewal reminder |
CustomPreExpireNotificationBody | form | string | No | Custom message for advanced renewal reminder |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Success | form | bool | No | Flag used to represent if membership renewal details updated successfully |
Message | form | string | No | Message used to represent if membership renewal details updated successfully |
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.
PUT /Ams/{ClientID}/MembershipRenewalReminder HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
membershipRenewalReminder:
{
Id: 0,
AdvanceRenewalReminder:
[
{
ReminderType: 0,
SendMembershipReminder: False,
AdvanceMembershipRenewalReminderDays: 0,
UseCustomPreExpireNotification: False,
CustomPreExpireSubject: String,
CustomPreExpireNotificationBody: String
}
],
AdvanceMembershipRenewalDays: 0,
UseCustomLastDayExpireNotification: False,
UseCustomPostExpireNotication: False,
CustomLastDaySubject: String,
CustomLastDayNotificationBody: String,
CustomPostExpireSubject: String,
CustomPostExpireNotificationBody: String,
MembershipName: String,
PostExpireMembershipRenewalDays: 0,
SendPostExpireMembershipReminder: False,
SendLastDayExpireMembershipReminder: False
},
MemberID: 0,
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:43:45.0572461-05:00,
Device: Desktop
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Success: False, Message: String, membershipRenewalReminder: { Id: 0, AdvanceRenewalReminder: [ { ReminderType: 0, SendMembershipReminder: False, AdvanceMembershipRenewalReminderDays: 0, UseCustomPreExpireNotification: False, CustomPreExpireSubject: String, CustomPreExpireNotificationBody: String } ], AdvanceMembershipRenewalDays: 0, UseCustomLastDayExpireNotification: False, UseCustomPostExpireNotication: False, CustomLastDaySubject: String, CustomLastDayNotificationBody: String, CustomPostExpireSubject: String, CustomPostExpireNotificationBody: String, MembershipName: String, PostExpireMembershipRenewalDays: 0, SendPostExpireMembershipReminder: False, SendLastDayExpireMembershipReminder: False }, MemberID: 0, 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:43:45.0737008-05:00, Device: Desktop }