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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<MembershipRenewalReminderPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services">
<BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
<ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
<Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
<membershipRenewalReminder>
<AdvanceMembershipRenewalDays>0</AdvanceMembershipRenewalDays>
<AdvanceRenewalReminder>
<AdvanceRenewalReminder>
<AdvanceMembershipRenewalReminderDays>0</AdvanceMembershipRenewalReminderDays>
<CustomPreExpireNotificationBody>String</CustomPreExpireNotificationBody>
<CustomPreExpireSubject>String</CustomPreExpireSubject>
<ReminderType>0</ReminderType>
<SendMembershipReminder>false</SendMembershipReminder>
<UseCustomPreExpireNotification>false</UseCustomPreExpireNotification>
</AdvanceRenewalReminder>
</AdvanceRenewalReminder>
<CustomLastDayNotificationBody>String</CustomLastDayNotificationBody>
<CustomLastDaySubject>String</CustomLastDaySubject>
<CustomPostExpireNotificationBody>String</CustomPostExpireNotificationBody>
<CustomPostExpireSubject>String</CustomPostExpireSubject>
<Id>0</Id>
<MembershipName>String</MembershipName>
<PostExpireMembershipRenewalDays>0</PostExpireMembershipRenewalDays>
<SendLastDayExpireMembershipReminder>false</SendLastDayExpireMembershipReminder>
<SendPostExpireMembershipReminder>false</SendPostExpireMembershipReminder>
<UseCustomLastDayExpireNotification>false</UseCustomLastDayExpireNotification>
<UseCustomPostExpireNotication>false</UseCustomPostExpireNotication>
</membershipRenewalReminder>
</MembershipRenewalReminderPutRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <MembershipRenewalReminderPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services"> <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache> <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID> <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID> <membershipRenewalReminder> <AdvanceMembershipRenewalDays>0</AdvanceMembershipRenewalDays> <AdvanceRenewalReminder> <AdvanceRenewalReminder> <AdvanceMembershipRenewalReminderDays>0</AdvanceMembershipRenewalReminderDays> <CustomPreExpireNotificationBody>String</CustomPreExpireNotificationBody> <CustomPreExpireSubject>String</CustomPreExpireSubject> <ReminderType>0</ReminderType> <SendMembershipReminder>false</SendMembershipReminder> <UseCustomPreExpireNotification>false</UseCustomPreExpireNotification> </AdvanceRenewalReminder> </AdvanceRenewalReminder> <CustomLastDayNotificationBody>String</CustomLastDayNotificationBody> <CustomLastDaySubject>String</CustomLastDaySubject> <CustomPostExpireNotificationBody>String</CustomPostExpireNotificationBody> <CustomPostExpireSubject>String</CustomPostExpireSubject> <Id>0</Id> <MembershipName>String</MembershipName> <PostExpireMembershipRenewalDays>0</PostExpireMembershipRenewalDays> <SendLastDayExpireMembershipReminder>false</SendLastDayExpireMembershipReminder> <SendPostExpireMembershipReminder>false</SendPostExpireMembershipReminder> <UseCustomLastDayExpireNotification>false</UseCustomLastDayExpireNotification> <UseCustomPostExpireNotication>false</UseCustomPostExpireNotication> </membershipRenewalReminder> <Message>String</Message> <Success>false</Success> </MembershipRenewalReminderPutResponse>