API reference · Campaigns

Update campaign reminders

PUT/v1/campaigns/{campaignId}/reminders

Set the reminders sent to the participants of an EMAIL or SLACK campaign who have not chosen a charity yet: 3 START reminders counted in days after the sending date and 3 END reminders counted in days before the end date. Read the current ones with includeReminders on get-campaign.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

campaignId#stringin pathrequired

Body

UpdateCampaignRemindersDto

This field has no description in the spec.

reminders#CampaignReminderPayload[]requiredat least 6 itemsat most 6 items
4 child fields
- campaignReminderIdstringUUID
  Id of an existing reminder of the campaign. Required once the campaign has reminders.
- typestring
  Required when the campaign has no reminders yet.
  STARTEND
- statusstringrequired
  ENABLEDDISABLED
- numberOfDaysnumberrequiredintegerminimum 1maximum 90

Response

200 · CampaignReminder[]

No field is described in the spec.

campaignReminderId#stringalways returned
status#CampaignReminderStatusalways returned
ENABLEDDISABLED
type#CampaignReminderTypealways returned
STARTEND
numberOfDays#numberalways returned
enabledDays#ReminderDay[]always returned
hour#numberalways returned
minute#numberalways returned
accountId#stringalways returned
campaignId#stringalways returned
createdAt#string (date-time)always returned
updatedAt#string (date-time)always returned

Errors

400Reminder type is required for each reminder

{
  "statusCode": 400,
  "message": "Reminder type is required for each reminder",
  "error": "Bad Request"
}

400Exactly 3 START and 3 END reminders are required

{
  "statusCode": 400,
  "message": "Exactly 3 START and 3 END reminders are required",
  "error": "Bad Request"
}

400Invalid campaignReminderId

{
  "statusCode": 400,
  "message": "Invalid campaignReminderId",
  "error": "Bad Request"
}

400A field is missing, has the wrong type, or is not part of the request schema.

Every request with a body or query is validated.

{
  "statusCode": 400,
  "message": [
    "amount must not be less than 1",
    "property foo should not exist"
  ],
  "error": "Bad Request"
}

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
```
{
  "statusCode": 403,
  "message": "Forbidden"
}
```
404Not Found
No resource with this id on your account: the API answers as if it did not exist.
```
{
  "statusCode": 404,
  "message": "Not Found"
}
```

PUT /v1/campaigns/<campaignId>/reminders

1curl -X PUT https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/reminders \2  -H "Authorization: Bearer $CHARITIPS_TOKEN" \3  -H "Content-Type: application/json" \4  -d '{5    "reminders": []6  }'

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.