Salutations Test
CRM/Salutations/{salutationId}
Update a salutation.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Salutations/{salutationId}

URI Parameters

Parameter Name Data Type Required Notes
salutationId integer Y

Request Body

Request object type : Salutation

Request object type Salutation has the following properties.
Property Name Data Type Length Required Readonly Notes
BusinessTitle string
Constituent Entity Y
FK: T_CUSTOMER.customer_no   Resource: Constituents
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
DefaultIndicator boolean N
EditIndicator boolean
EnvelopeSalutation1 string
EnvelopeSalutation2 string
Id integer Y Non-updatable
IsFromAffiliation boolean
Label boolean N
LetterSalutation string
SalutationType SalutationTypeSummary Y
FK: TR_SIGNOR.id   Resource: SalutationTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "BusinessTitle": "sample string 1",
  "CreatedDateTime": "2025-04-24T09:39:05.578399-07:00",
  "CreateLocation": "sample string 2",
  "Constituent": {
    "Id": 1
  },
  "CreatedBy": "sample string 3",
  "Id": 1,
  "DefaultIndicator": true,
  "EnvelopeSalutation1": "sample string 5",
  "EnvelopeSalutation2": "sample string 6",
  "Label": true,
  "UpdatedDateTime": "2025-04-24T09:39:05.578399-07:00",
  "UpdatedBy": "sample string 8",
  "LetterSalutation": "sample string 9",
  "SalutationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "EditIndicator": true,
  "IsFromAffiliation": true
}
<Salutation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BusinessTitle>sample string 1</BusinessTitle>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T09:39:05.578399-07:00</CreatedDateTime>
  <DefaultIndicator>true</DefaultIndicator>
  <EditIndicator>true</EditIndicator>
  <EnvelopeSalutation1>sample string 5</EnvelopeSalutation1>
  <EnvelopeSalutation2>sample string 6</EnvelopeSalutation2>
  <Id>1</Id>
  <IsFromAffiliation>true</IsFromAffiliation>
  <Label>true</Label>
  <LetterSalutation>sample string 9</LetterSalutation>
  <SalutationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </SalutationType>
  <UpdatedBy>sample string 8</UpdatedBy>
  <UpdatedDateTime>2025-04-24T09:39:05.578399-07:00</UpdatedDateTime>
</Salutation>

Response object type : Salutation

Response object type Salutation has the following properties.
Property Name Data Type Length Required Readonly Notes
BusinessTitle string
Constituent Entity Y
FK: T_CUSTOMER.customer_no   Resource: Constituents
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
DefaultIndicator boolean N
EditIndicator boolean
EnvelopeSalutation1 string
EnvelopeSalutation2 string
Id integer Y Non-updatable
IsFromAffiliation boolean
Label boolean N
LetterSalutation string
SalutationType SalutationTypeSummary Y
FK: TR_SIGNOR.id   Resource: SalutationTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
{
  "BusinessTitle": "sample string 1",
  "CreatedDateTime": "2025-04-24T09:39:05.578399-07:00",
  "CreateLocation": "sample string 2",
  "Constituent": {
    "Id": 1
  },
  "CreatedBy": "sample string 3",
  "Id": 1,
  "DefaultIndicator": true,
  "EnvelopeSalutation1": "sample string 5",
  "EnvelopeSalutation2": "sample string 6",
  "Label": true,
  "UpdatedDateTime": "2025-04-24T09:39:05.578399-07:00",
  "UpdatedBy": "sample string 8",
  "LetterSalutation": "sample string 9",
  "SalutationType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "EditIndicator": true,
  "IsFromAffiliation": true
}
<Salutation xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BusinessTitle>sample string 1</BusinessTitle>
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 2</CreateLocation>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedDateTime>2025-04-24T09:39:05.578399-07:00</CreatedDateTime>
  <DefaultIndicator>true</DefaultIndicator>
  <EditIndicator>true</EditIndicator>
  <EnvelopeSalutation1>sample string 5</EnvelopeSalutation1>
  <EnvelopeSalutation2>sample string 6</EnvelopeSalutation2>
  <Id>1</Id>
  <IsFromAffiliation>true</IsFromAffiliation>
  <Label>true</Label>
  <LetterSalutation>sample string 9</LetterSalutation>
  <SalutationType>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </SalutationType>
  <UpdatedBy>sample string 8</UpdatedBy>
  <UpdatedDateTime>2025-04-24T09:39:05.578399-07:00</UpdatedDateTime>
</Salutation>
Change Version Description Contract Old New
Parameter Changed 15.0.0 salutationId has been marked as required. Required