---
title: "Update invitation template"
method: PUT
path: "/api-regulated/v1/invitation-templates/{id}"
tags: ["InvitationTemplate"]
---

# Update invitation template

`PUT /api-regulated/v1/invitation-templates/{id}`

## Request

- Base URL: `https://api.currencyguard.com`
- URL: `https://api.currencyguard.com/api-regulated/v1/invitation-templates/{id}`
- Auth: OAuth 2 (implicit, authorization URL `https://auth.currencyguard.com/oauth2/authorize`, scopes: `regulated.templates.canEditEmailTemplate`)

Updates the email message and/or subject for an existing invitation template (non-internal only).

**Required entitlement:** `regulated.templates.canEditEmailTemplate`  
_Entitles the regulated user to manage invitation email templates for their regulated entity_

## Path parameters

- `id` string, uuid, required

## Request body

- InvitationTemplateDTOUpdate: Schema for representing a InvitationTemplate
  - `entitlementsTemplateId` string, uuid: The entitlements template this invitation template is linked to.
  - `invitationEmailMessage` string: The full HTML email body template for invitation emails. Supports variable placeholders: ${firstName}, ${lastName}, ${regulatedEntityName}, ${introducingBrokerName}, ${currencyGuardCompanyName}, ${acceptanceUrl}, ${currentYear}, and logo variables.
  - `invitationEmailSubject` string: The invitation email subject line template with variable placeholders.

## Response `200`

Template updated successfully

- InvitationTemplateDTO: Schema for representing a InvitationTemplate
  - `id` string, uuid: The unique identifier for the invitation template.
  - `entitlementsTemplateId` string, uuid: The entitlements template this invitation template is linked to.
  - `invitationEmailMessage` string: The full HTML email body template for invitation emails. Supports variable placeholders: ${firstName}, ${lastName}, ${regulatedEntityName}, ${introducingBrokerName}, ${currencyGuardCompanyName}, ${acceptanceUrl}, ${currentYear}, and logo variables.
  - `invitationEmailSubject` string: The invitation email subject line template with variable placeholders.
  - `versionNumber` integer: The strictly monotonically increasing version number for this record.
  - `updatedBy` string: The username of the person or entity that updated this record.
  - `updatedAt` string: The timestamp of the last update in UTC.
  - `createdAt` string: The timestamp of creation in UTC.

## Other responses

- `400`: Invalid request data — [`http/malformed-request`](/problems/http/malformed-request/)
- `404`: Template not found — [`http/resource-not-found`](/problems/http/resource-not-found/)

---

[API](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external.md) · [All operations](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/llms.txt) · [OpenAPI document](https://skmtc.dev/currencyguard/apis/currencyguard-trading-system-api-external/revisions/a1f3f854190d?raw)