Skip to content
Aller au contenu
Charitips

API reference · Campaigns

Update a campaign translation

PATCH/v1/campaigns/{campaignId}/translations/{campaignTranslationId}

Update a given translation.

Requires a Bearer access token.

Parameters

No field is described in the spec.

  • campaignId#stringin pathrequired

  • campaignTranslationId#stringin pathrequired

Body

UpdateCampaignTranslationDto
  • title#string2 to 100 characters

    Will be displayed in the campaign page

  • description#string2 to 1000 characters

    Will be displayed in the campaign page.

  • message#string1 to 600 characters

    Slack campaigns only. Message posted to each participant with their donation. Supports the {{firstName}}, {{lastName}}, {{company}} and {{amount}} variables.

  • reminderMessage#string1 to 600 characters

    Slack 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 characters

    Email campaigns only. Name of the sender of the donation emails.

  • emailSenderPictureUrl#stringURL

    Email campaigns only. Picture of the sender displayed in the donation emails.

  • emailSubject#string1 to 100 characters

    Email campaigns only. Subject of the donation emails.

  • emailTemplate#string1 to 1000 characters

    Email campaigns only. HTML body of the donation emails. Supports the {{firstName}}, {{lastName}}, {{company}} and {{amount}} variables.

  • emailReplyTo#stringemail address

    Email campaigns only. Address the participants reply to.

  • emailDisplayCard#boolean

    Email campaigns only. Whether the donation emails show the donation card. Defaults to true.

Response

200 · CampaignTranslation

No field is described in the spec.

  • campaignTranslationId#stringalways returned

  • language#Languagealways returned

    fren

  • title#string

  • description#string

  • logoUrl#string

  • message#string

  • reminderMessage#string

  • emailSenderName#string

  • emailSenderPictureUrl#string

  • emailSubject#string

  • emailTemplate#string

  • emailReplyTo#string

  • emailDisplayCard#boolean

  • campaignId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (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"
    }
  • 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"
    }
PATCH /v1/campaigns/<campaignId>/translations/<campaignTranslationId>
curl -X PATCH https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/translations/<campaignTranslationId> \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "title": "<title>",    "description": "<description>"  }'
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.