POST api/textdescription/Save

Save. Processes this text description API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The text description save data contract supplied with the request.

TextDescriptionSaveDataContract

Name	Description	Type	Additional information
Text	The text value.	string	None.
Type	The type value.	EnumDataContract	None.
Name	The name value.	string	None.
Notes	The notes value.	string	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
RoleId	The unique identifier of the related role resource.	integer	None.
ForceUpdate	Indicates whether force update is true.	boolean	None.
Id	The unique identifier of this resource.	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Text": "sample string 1",
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Name": "sample string 2",
  "Notes": "sample string 3",
  "PropertyId": 4,
  "RoleId": 5,
  "ForceUpdate": true,
  "Id": 7
}

Response Information

Resource Description

The response returned after the operation completes.

TagDescriptionDataContract

Name	Description	Type	Additional information
Tags	The collection of tags.	Collection of OrderedTagDataContract	None.
Name	The name value.	string	None.
Order	The order value.	integer	None.
Type	The type value.	EnumDataContract	None.
PropertyId	The unique identifier of the related property resource.	integer	None.
Notes	The notes value.	string	None.
Roles	The collection of roles.	Collection of DescriptionRoleDataContract	None.
CreatedDate	The created date, expressed as a date and time.	date	None.
CreatedBy	The created by value.	CreatedByDataContract	None.
Id	The unique identifier of this resource.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Tags": [
    {
      "Name": "sample string 1",
      "Order": 2,
      "SelectedTagId": 3,
      "Id": 4
    },
    {
      "Name": "sample string 1",
      "Order": 2,
      "SelectedTagId": 3,
      "Id": 4
    }
  ],
  "Name": "sample string 1",
  "Order": 2,
  "Type": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "PropertyId": 3,
  "Notes": "sample string 4",
  "Roles": [
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    },
    {
      "Name": "sample string 1",
      "RoleType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "RoleStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Id": 2
    }
  ],
  "CreatedDate": "2026-07-23T08:12:07.858732Z",
  "CreatedBy": {
    "Initials": "sample string 1",
    "ContactName": "sample string 2",
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "PrimaryTelephone": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "PrimaryEmail": {
      "Type": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Value": "sample string 1",
      "Notes": "sample string 2",
      "ContactOrder": 3,
      "AllowContact": true,
      "MarketingContactStatus": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Name": "sample string 5",
      "Id": 6
    },
    "JobTitle": "sample string 6",
    "Id": 7
  },
  "Id": 6
}