Skip to content
Home/
REST API Reference
/
/
Update Conversation Attri...

Update Conversation Attribute Request

Payload for updating a conversation attribute.

namestring

Name of the attribute.

Example:"api_test_renamed"
descriptionstring

Readable description of the attribute.

Example:"Updated via API"
multilineboolean

(String data type only) Whether this string attribute is multiline.

Example:false
requiredboolean

Whether this attribute is required.

Example:false
visible_to_team_idsArray of strings

Team IDs that can see this attribute. Empty array means all teams.

Example:
[]
referenceobject

(Relationship data type only) Reference configuration for related objects.

{
  "name": "api_test_renamed",
  "description": "Updated via API",
  "multiline": false,
  "required": false,
  "visible_to_team_ids": [],
  "reference": {
    "type": "one",
    "object_type_id": "string"
  }
}