POST api/v1/donoraccess/recurrence?token={token}

Update Recurrence

Request Information

URI Parameters

Name	Description	Type	Additional information
token	Valid donor token retrieved from token end point	string	Required

Body Parameters

Donor recurrence object that needs to be updated in ProVision

DonorAccessRecurrence

Name	Type	Additional information
ClientCode	string	String length: inclusive between 0 and 10
Division	string	None.
Start	date	None.
End	date	None.
Interval	string	None.
IntervalCount	integer	None.
NextCharge	date	None.
Status	string	None.
Amount	decimal number	None.
DonationCode	string	None.
DonationDescription	string	None.
Fund	string	None.
FundDescription	string	None.
TransactionID	string	None.
TransactionDate	date	None.
RecurrenceType	string	None.
ExternalReference	string	None.
ExternalOrigin	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientCode": "sample string 1",
  "Division": "sample string 2",
  "Start": "2025-09-04T15:05:24.149",
  "End": "2025-09-04T15:05:24.149",
  "Interval": "sample string 5",
  "IntervalCount": 6,
  "NextCharge": "2025-09-04T15:05:24.149",
  "Status": "sample string 8",
  "Amount": 9.0,
  "DonationCode": "sample string 10",
  "DonationDescription": "sample string 11",
  "Fund": "sample string 12",
  "FundDescription": "sample string 13",
  "TransactionID": "sample string 14",
  "TransactionDate": "2025-09-04T15:05:24.149",
  "RecurrenceType": "sample string 16",
  "ExternalReference": "sample string 17",
  "ExternalOrigin": "sample string 18"
}

application/xml, text/xml

Sample:

<DonorAccessRecurrence xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Amount>9</Amount>
  <ClientCode>sample string 1</ClientCode>
  <Division>sample string 2</Division>
  <DonationCode>sample string 10</DonationCode>
  <DonationDescription>sample string 11</DonationDescription>
  <End>2025-09-04T15:05:24.1490256+00:00</End>
  <ExternalOrigin>sample string 18</ExternalOrigin>
  <ExternalReference>sample string 17</ExternalReference>
  <Fund>sample string 12</Fund>
  <FundDescription>sample string 13</FundDescription>
  <Interval>sample string 5</Interval>
  <IntervalCount>6</IntervalCount>
  <NextCharge>2025-09-04T15:05:24.1490256+00:00</NextCharge>
  <RecurrenceType>sample string 16</RecurrenceType>
  <Start>2025-09-04T15:05:24.1490256+00:00</Start>
  <Status>sample string 8</Status>
  <TransactionDate>2025-09-04T15:05:24.1490256+00:00</TransactionDate>
  <TransactionID>sample string 14</TransactionID>
</DonorAccessRecurrence>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.