List campaign templates

• limit#numberin queryintegerminimum 1maximum 100

  The max number of items to return.

• cursor#stringin queryUUID

  The id of the last item from the previous page. Used to fetch the next page.

• language#stringin query

  Get templates in a specific language.

  fren

• type#stringin query

  Filter by type.

  GENERICINDUSTRY_SPECIFIC

• segment#stringin query

  Filter by segment.

  CSRMARKETINGHRSALESCOMMUNICATIONGLOBALSMB

• campaignTemplateGoalId#stringin queryUUID

  Filter by goal.

• slug#stringin query

  Find a campaign template by its slug.

• includeCampaigns#booleanin query

  Include campaigns

  Required in the spec, optional for the API.

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

• 400accountId is required when includeCampaigns is true

  {
    "statusCode": 400,
    "message": "accountId is required when includeCampaigns is true",
    "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"
  }