UpdateConversation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/frontapp/main/json-schema/frontapp-update-conversation-schema.json",
  "title": "UpdateConversation",
  "x-generated": "2026-10-14",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/frontapp-core-api-openapi.yml#/components/schemas/UpdateConversation",
  "properties": {
    "assignee_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "ID of the teammate to assign the conversation to. Set it to null to unassign."
    },
    "inbox_id": {
      "type": "string",
      "description": "ID of the inbox to move the conversation to."
    },
    "status": {
      "type": "string",
      "description": "New status of the conversation",
      "enum": [
        "archived",
        "open",
        "deleted",
        "spam"
      ]
    },
    "status_id": {
      "type": "string",
      "description": "Unique identifier of the status to set the conversation to. Only one of status and status_id should be provided. Ticketing must be enabled for the company to use this field."
    },
    "tag_ids": {
      "type": "array",
      "description": "List of all the tag IDs replacing the old conversation tags",
      "items": {
        "$ref": "#/$defs/ResourceID"
      }
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 65535,
      "description": "Description of the task. Only allowed on task conversations. Set to null to clear."
    },
    "due_at": {
      "type": [
        "number",
        "null"
      ],
      "description": "Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed on task conversations. Set to null to clear."
    },
    "custom_fields": {
      "description": "Custom fields for this conversation. If you want to keep all custom fields the same when updating this resource, do not include any custom fields in the update. If you want to update custom fields, make sure to include all custom fields, not just the fields you want to add or update. If you send only the custom fields you want to update, the other custom fields will be erased. You can retrieve the existing custom fields before making the update to note the current fields. Send as an object of key:value pairs where the key is the custom field name and the value is the custom field value.",
      "$ref": "#/$defs/CustomFieldParameter"
    }
  },
  "$defs": {
    "CustomFieldParameter": {
      "type": "object",
      "description": "An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields"
    },
    "ResourceID": {
      "type": "string"
    }
  }
}