Skip to content
Aller au contenu
Charitips

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

GetCampaignTemplateDto
  • language#string

    Get template in a specific language.

    fren

Response

200 · LocalizedCampaignTemplate

No field is described in the spec.

  • campaignTemplateId#stringalways returned

  • name#stringalways returned

  • description#stringalways returned

  • why#stringalways returned

  • donationMethod#stringalways returned

  • slug#stringalways returned

  • type#CampaignTemplateTypealways returned

    GENERICINDUSTRY_SPECIFIC

  • segment#CampaignTemplateSegmentalways returned

    CSRMARKETINGHRSALESCOMMUNICATIONGLOBALSMB

  • industry#CampaignTemplateIndustryalways returned

    ALLRETAILITFINANCETRANSPORTENERGYHOSPITALITYEDUCATIONSERVICESWELLNESSENTERTAINMENT

  • isFeatured#booleanalways returned

  • isSelfServe#booleanalways returned

  • isInternal#booleanalways returned

  • causes#Cause[]always returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

  • goals#CampaignTemplateGoal[]always returned

    5 child fields
    • campaignTemplateGoalIdstringalways returned

    • labelstringalways returned

    • slugstringalways returned

    • createdAtstring (date-time)always returned

    • updatedAtstring (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"
    }
GET /v1/campaign-templates/<campaignTemplateId>
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"  }'
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.