Interests Test
CRM/Interests/{interestId}
Update an interest. If the interest is not selected and the weight is 0 or null, it will be deleted.

For bulk interest edits, consider the CRM/Interests/CreateOrUpdate batching resource which allows multiple interests to be created, updated, or removed in a single request.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Interests/{interestId}

URI Parameters

Parameter Name Data Type Required Notes
interestId integer Y

Request Body

Request object type : Interest

Request object type Interest has the following properties.
Property Name Data Type Length Required Readonly Notes
Constituent Entity Y Constituent that the Interest is associated.
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean N readonly Whether this interest is editable based on control group permission.
Id integer Y Non-updatable
InterestType InterestTypeSummary Y Type of the interest. Only one entity of this type may be created per constituent.
FK: TR_TKW.id   Resource: InterestTypes
Selected boolean N Typically indicates a selection that the constituent has made.
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
Weight integer N A value weighting the constituent's association to this interest type, complementing or in opposition to their indicated selections. 
{
  "InterestType": {
    "Description": "sample string 1",
    "Id": 1,
    "UsedIn": "sample string 2",
    "Category": {
      "Description": "sample string 1",
      "Id": 1
    },
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    }
  },
  "Constituent": {
    "Id": 1
  },
  "CreatedDateTime": "2025-04-24T05:08:06.8180575-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T05:08:06.8180575-07:00",
  "UpdatedBy": "sample string 3",
  "Selected": true,
  "Weight": 1,
  "EditIndicator": true
}
<Interest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:08:06.8180575-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <Id>1</Id>
  <InterestType>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
    </Category>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <UsedIn>sample string 2</UsedIn>
  </InterestType>
  <Selected>true</Selected>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:08:06.8180575-07:00</UpdatedDateTime>
  <Weight>1</Weight>
</Interest>

Response object type : Interest

Response object type Interest has the following properties.
Property Name Data Type Length Required Readonly Notes
Constituent Entity Y Constituent that the Interest is associated.
CreatedBy string N Non-updatable
CreatedDateTime date N Non-updatable
CreateLocation string N Non-updatable
EditIndicator boolean N readonly Whether this interest is editable based on control group permission.
Id integer Y Non-updatable
InterestType InterestTypeSummary Y Type of the interest. Only one entity of this type may be created per constituent.
FK: TR_TKW.id   Resource: InterestTypes
Selected boolean N Typically indicates a selection that the constituent has made.
UpdatedBy string N Auto-assigned
UpdatedDateTime date Y Auto-assigned
Weight integer N A value weighting the constituent's association to this interest type, complementing or in opposition to their indicated selections. 
{
  "InterestType": {
    "Description": "sample string 1",
    "Id": 1,
    "UsedIn": "sample string 2",
    "Category": {
      "Description": "sample string 1",
      "Id": 1
    },
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    }
  },
  "Constituent": {
    "Id": 1
  },
  "CreatedDateTime": "2025-04-24T05:08:06.8180575-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T05:08:06.8180575-07:00",
  "UpdatedBy": "sample string 3",
  "Selected": true,
  "Weight": 1,
  "EditIndicator": true
}
<Interest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Constituent>
    <Id>1</Id>
  </Constituent>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:08:06.8180575-07:00</CreatedDateTime>
  <EditIndicator>true</EditIndicator>
  <Id>1</Id>
  <InterestType>
    <Category>
      <Description>sample string 1</Description>
      <Id>1</Id>
    </Category>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <UsedIn>sample string 2</UsedIn>
  </InterestType>
  <Selected>true</Selected>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:08:06.8180575-07:00</UpdatedDateTime>
  <Weight>1</Weight>
</Interest>
Change Version Description Contract Old New
Parameter Changed 15.0.0 interestId has been marked as required. Required