Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Campaign Series Iteration

updateCampaignSeriesIteration

Update a Campaign Series iteration

put/campaign-series-iterations/{campaign_series_iteration}

Path parameters

campaign_series_iterationinteger required
Example:73626

The specified Campaign Series iteration ID

Request body

end_datestring date-time nullable

Date on which the Campaign Series Iteration ends

num_donors_goalinteger nullable

Donors goal for Campaign Series Iteration

num_fundraisers_goalinteger nullable

Fundraiser goal for Campaign Series Iteration

num_recurring_donors_goalinteger nullable

Recurring goal for Campaign Series Iteration

num_teams_goalinteger nullable

Team goal for Campaign Series Iteration

total_fundraising_goalinteger nullable

Total fundraising goal for Campaign Series Iteration

total_online_fundraising_goalinteger nullable

Total online fundraising goal for Campaign Series Iteration

start_datestring date-time nullable

Date on which the Campaign Series Iteration starts

previous_iteration_idinteger nullable

The parent reference iteration representing the 'previous iteration'

campaign_template_idinteger nullable

The template used when creating new campaigns in this iteration

Example request

{
  "end_date": "2021-04-23T08:23:21Z",
  "num_donors_goal": 1000,
  "num_fundraisers_goal": 1000,
  "num_recurring_donors_goal": 1000,
  "num_teams_goal": 1000,
  "total_fundraising_goal": 1000,
  "total_online_fundraising_goal": 1000,
  "start_date": "2021-04-23T08:23:21Z",
  "previous_iteration_id": 145987,
  "campaign_template_id": 245798
}

Response

Success

end_datestring date-time nullable

Date on which the Campaign Series Iteration ends

num_donors_goalinteger nullable

Donors goal for Campaign Series Iteration

num_fundraisers_goalinteger nullable

Fundraiser goal for Campaign Series Iteration

num_recurring_donors_goalinteger nullable

Recurring goal for Campaign Series Iteration

num_teams_goalinteger nullable

Team goal for Campaign Series Iteration

total_fundraising_goalinteger nullable

Total fundraising goal for Campaign Series Iteration

total_online_fundraising_goalinteger nullable

Total online fundraising goal for Campaign Series Iteration

start_datestring date-time nullable

Date on which the Campaign Series Iteration starts

previous_iteration_idinteger nullable

The parent reference iteration representing the 'previous iteration'

campaign_template_idinteger nullable

The template used when creating new campaigns in this iteration

namestring

Public name for the campaign series

descriptionstring

Description of the campaign series

created_byinteger nullable

Created By Member Id

idinteger nullable

Campaign Series Iteration Entity Id

created_atstring date-time

Date/time of initial record creation

updated_atstring date-time

Date/time of record last updated

Example response

{
  "end_date": "2021-04-23T08:23:21Z",
  "num_donors_goal": 1000,
  "num_fundraisers_goal": 1000,
  "num_recurring_donors_goal": 1000,
  "num_teams_goal": 1000,
  "total_fundraising_goal": 1000,
  "total_online_fundraising_goal": 1000,
  "start_date": "2021-04-23T08:23:21Z",
  "previous_iteration_id": 145987,
  "campaign_template_id": 245798,
  "name": "Test Campaign Series",
  "description": "Annual 5k to raise funds for our mission",
  "created_by": 2012,
  "id": 45621,
  "created_at": "2021-04-23T08:23:21Z",
  "updated_at": "2021-04-23T08:23:21Z"
}