Global

Update query template detail

post/sites/{site-identifier}/query-templates/{query-template-guid}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/query-templates/{query-template-guid}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Request body

TemplateNamestring
TemplateActiveboolean
TemplateType'TEXT' | 'FORM'
TemplateMessageTextstring
WorkflowTemplateCodestring

(Only supprot FUND/FUND-MEMBER/PORTFOLIO/PORTFOLIO-MEMBER entity type workflows)

Entitystring
Subjectstring
DocumentConfidentiality'MANDATORY' | 'OPTIONAL' | 'NO-RESTRICTION'
SendImmediatelyboolean
HighPriorityboolean
DueDateReferenceValue'NONE' | 'CREATION-DATE' | 'LODGEMENT-DUE-DATE' | 'END-OF-CURRENT-MONTH' | 'END-OF-NEXT-MONTH' | 'END-OF-CURRENT-QUARTER' | 'END-OF-NEXT-QUARTER' | 'END-OF-CURRENT-FIN-YEAR'
DueDateAdjustmentValueinteger
DueDateAdjustmentUnitType'DAYS'
ReminderReferenceValue'NONE' | 'TODAY' | 'DUE-DATE'
ReminderAdjustmentValueinteger
ReminderAdjustmentUnitType'DAYS'
ReminderFrequency'NONE' | 'WEEKLY' | 'FORTNIGHTLY' | 'MONTHLY'

Example request

{
  "TemplateName": "Template name",
  "TemplateMessageText": "Template message text",
  "Entity": "Fund|Member|Pension|Account",
  "SendImmediately": true,
  "HighPriority": true,
  "DueDateAdjustmentValue": 4,
  "ReminderAdjustmentValue": 2
}

Response

Success

Changes

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