API reference · Campaigns
Add a campaign translation
PUT/v1/campaigns/{campaignId}/translations
Create a translation for a campaign's text properties. Properties not provided will be automatically machine translated.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
campaignId#stringin pathrequired
Body
AddCampaignTranslationDtotitle#string2 to 100 charactersWill be displayed in the campaign page
description#string2 to 1000 charactersWill be displayed in the campaign page.
message#string1 to 600 charactersSlack campaigns only. Message posted to each participant with their donation. Supports the {{firstName}}, {{lastName}}, {{company}} and {{amount}} variables.
reminderMessage#string1 to 600 charactersSlack campaigns only. Message posted to remind the participants who have not chosen a charity yet. Supports the {{firstName}}, {{lastName}}, {{company}} and {{amount}} variables.
emailSenderName#string1 to 100 charactersEmail campaigns only. Name of the sender of the donation emails.
emailSenderPictureUrl#stringURLEmail campaigns only. Picture of the sender displayed in the donation emails.
emailSubject#string1 to 100 charactersEmail campaigns only. Subject of the donation emails.
emailTemplate#string1 to 1000 charactersEmail campaigns only. HTML body of the donation emails. Supports the {{firstName}}, {{lastName}}, {{company}} and {{amount}} variables.
emailReplyTo#stringemail addressEmail campaigns only. Address the participants reply to.
emailDisplayCard#booleanEmail campaigns only. Whether the donation emails show the donation card. Defaults to true.
language#stringrequiredTranslation locale
fren
Errors
400Language is already the default language
{ "statusCode": 400, "message": "Language is already the default language", "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" }
curl -X PUT https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/translations \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "language": "fr" }'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.