Skip to content
campaiDeveloper
campai.com

Templates · Design

POST/{organizationId}/templates/pdfBackground

Update PDF background

Replace or remove the PDF overlay on the letter designs of the given contact, receipt and donation confirmation templates. Templates without a letter design are skipped.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • template.edit
Also checked, depending on the request and the records it touches
  • receipt.edit
  • donationsSettings.edit
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read

Request

Path parameters

  • organizationIdidrequired

Body

Content-Type: application/json

  • templateIdsid[]required

    1–100 items

  • attachmentstringrequirednullable

    at least 1 characters

Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/templates/pdfBackground' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • updatedinteger

    at least 0

Response200
{
  "updated": 0
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.