API reference · Campaign Templates
Get a campaign template
GET/v1/campaign-templates/{campaignTemplateId}
Retrieve information about a campaign template.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
campaignTemplateId#stringin pathrequired
Body
GetCampaignTemplateDtolanguage#stringGet template in a specific language.
fren
Response
200 · LocalizedCampaignTemplateNo field is described in the spec.
campaignTemplateId#stringalways returnedname#stringalways returneddescription#stringalways returnedwhy#stringalways returneddonationMethod#stringalways returnedslug#stringalways returnedtype#CampaignTemplateTypealways returnedGENERICINDUSTRY_SPECIFICsegment#CampaignTemplateSegmentalways returnedCSRMARKETINGHRSALESCOMMUNICATIONGLOBALSMBindustry#CampaignTemplateIndustryalways returnedALLRETAILITFINANCETRANSPORTENERGYHOSPITALITYEDUCATIONSERVICESWELLNESSENTERTAINMENTisFeatured#booleanalways returnedisSelfServe#booleanalways returnedisInternal#booleanalways returnedcauses#Cause[]always returnedcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returnedgoals#CampaignTemplateGoal[]always returned5 child fields
campaignTemplateGoalIdstringalways returnedlabelstringalways returnedslugstringalways returnedcreatedAtstring (date-time)always returnedupdatedAtstring (date-time)always returned
Errors
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" }
curl -X GET https://api.sandbox.charitips.com/v1/campaign-templates/<campaignTemplateId> \ -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.