InvitationTemplate

Update invitation template

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

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)

Path parameters

idstring uuid required

Request body

entitlementsTemplateIdstring uuid

The entitlements template this invitation template is linked to.

invitationEmailMessagestring

The full HTML email body template for invitation emails. Supports variable placeholders: ${firstName}, ${lastName}, ${regulatedEntityName}, ${introducingBrokerName}, ${currencyGuardCompanyName}, ${acceptanceUrl}, ${currentYear}, and logo variables.

invitationEmailSubjectstring

The invitation email subject line template with variable placeholders.

Example request

{
  "entitlementsTemplateId": "550e8400-e29b-41d4-a716-446655440001",
  "invitationEmailMessage": "<p>Dear ${firstName},</p><p>Welcome to CurrencyGuard!</p>",
  "invitationEmailSubject": "Welcome to CurrencyGuard"
}

Response

Template updated successfully

idstring uuid

The unique identifier for the invitation template.

entitlementsTemplateIdstring uuid

The entitlements template this invitation template is linked to.

invitationEmailMessagestring

The full HTML email body template for invitation emails. Supports variable placeholders: ${firstName}, ${lastName}, ${regulatedEntityName}, ${introducingBrokerName}, ${currencyGuardCompanyName}, ${acceptanceUrl}, ${currentYear}, and logo variables.

invitationEmailSubjectstring

The invitation email subject line template with variable placeholders.

versionNumberinteger

The strictly monotonically increasing version number for this record.

updatedBystring

The username of the person or entity that updated this record.

updatedAtstring

The timestamp of the last update in UTC.

createdAtstring

The timestamp of creation in UTC.

Example response

{
  "id": "660f9511-f3bc-52f6-c938-668877662111",
  "entitlementsTemplateId": "550e8400-e29b-41d4-a716-446655440001",
  "invitationEmailMessage": "<p>Dear ${firstName},</p><p>Welcome to CurrencyGuard!</p>",
  "invitationEmailSubject": "Welcome to CurrencyGuard",
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.