{
  "type": "object",
  "title": "Deleted Section Object",
  "properties": {
    "id": {
      "type": "string",
      "example": "6890762",
      "description": "The unique identifier for the section which you provided in the URL."
    },
    "object": {
      "enum": [
        "section"
      ],
      "type": "string",
      "example": "section",
      "description": "The type of object which was deleted. - `section`"
    },
    "deleted": {
      "type": "boolean",
      "example": true,
      "description": "Whether the section was deleted successfully or not."
    }
  },
  "description": "Response returned when an object is deleted"
}

{
  "required": [
    "admin_id"
  ],
  "properties": {
    "admin_id": {
      "type": "string",
      "example": "5017690",
      "description": "The `id` of the admin who is performing the action."
    }
  }
}

{
  "type": "object",
  "title": "Error",
  "required": [
    "type",
    "errors"
  ],
  "properties": {
    "type": {
      "type": "string",
      "example": "error.list",
      "description": "The type is error.list"
    },
    "errors": {
      "type": "array",
      "items": {
        "required": [
          "code"
        ],
        "properties": {
          "code": {
            "type": "string",
            "example": "unauthorized",
            "description": "A string indicating the kind of error, used to further qualify the HTTP response code"
          },
          "field": {
            "type": "string",
            "example": "email",
            "nullable": true,
            "description": "Optional. Used to identify a particular field or query parameter that was in error."
          },
          "message": {
            "type": "string",
            "example": "Access Token Invalid",
            "nullable": true,
            "description": "Optional. Human readable description of the error."
          }
        }
      },
      "description": "An array of one or more error objects"
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "example": "f93ecfa8-d08a-4325-8694-89aeb89c8f85",
      "nullable": true,
      "description": ""
    }
  },
  "description": "The API will return an Error List for a failed request, which will contain one or more Error objects."
}

{
  "type": "object",
  "title": "File",
  "properties": {
    "url": {
      "type": "string",
      "example": "https://intercom-attachments-1.com/.../Screenshot.png",
      "description": "The url of the file. This is a temporary URL and will expire after 30 minutes."
    },
    "name": {
      "type": "string",
      "example": "Screenshot.png",
      "description": "The name of the file"
    },
    "type": {
      "type": "string",
      "example": "upload"
    },
    "width": {
      "type": "integer",
      "example": 3024,
      "description": "The width of the file in pixels, if applicable"
    },
    "height": {
      "type": "integer",
      "example": 1964,
      "description": "The height of the file in pixels, if applicable"
    },
    "filesize": {
      "type": "integer",
      "example": 11308309,
      "description": "The size of the file in bytes"
    },
    "content_type": {
      "type": "string",
      "example": "image/png",
      "description": "The type of file"
    }
  },
  "description": "The value describing a file upload set for a custom attribute"
}

{
  "type": "object",
  "title": "Group Content",
  "nullable": true,
  "properties": {
    "name": {
      "type": "string",
      "example": "Collection name",
      "description": "The name of the collection or section."
    },
    "type": {
      "enum": [
        null,
        "group_content"
      ],
      "type": "string",
      "example": "group_content",
      "nullable": true,
      "description": "The type of object - `group_content` ."
    },
    "description": {
      "type": "string",
      "example": " Collection description",
      "description": "The description of the collection. Only available for collections."
    }
  },
  "description": "The Content of a Group."
}

{
  "type": "object",
  "title": "Group Translated Content",
  "nullable": true,
  "properties": {
    "ar": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Arabic"
    },
    "bg": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Bulgarian"
    },
    "bs": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Bosnian"
    },
    "ca": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Catalan"
    },
    "cs": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Czech"
    },
    "da": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Danish"
    },
    "de": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in German"
    },
    "el": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Greek"
    },
    "en": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in English"
    },
    "es": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Spanish"
    },
    "et": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Estonian"
    },
    "fi": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Finnish"
    },
    "fr": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in French"
    },
    "he": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Hebrew"
    },
    "hr": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Croatian"
    },
    "hu": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Hungarian"
    },
    "id": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Indonesian"
    },
    "it": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Italian"
    },
    "ja": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Japanese"
    },
    "ko": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Korean"
    },
    "lt": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Lithuanian"
    },
    "lv": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Latvian"
    },
    "mn": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Mongolian"
    },
    "nb": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Norwegian"
    },
    "nl": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Dutch"
    },
    "pl": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Polish"
    },
    "pt": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Portuguese (Portugal)"
    },
    "ro": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Romanian"
    },
    "ru": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Russian"
    },
    "sl": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Slovenian"
    },
    "sr": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Serbian"
    },
    "sv": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Swedish"
    },
    "tr": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Turkish"
    },
    "vi": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Vietnamese"
    },
    "type": {
      "enum": [
        null,
        "group_translated_content"
      ],
      "type": "string",
      "example": "group_translated_content",
      "nullable": true,
      "description": "The type of object - group_translated_content."
    },
    "pt-BR": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Portuguese (Brazil)"
    },
    "zh-CN": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Chinese (China)"
    },
    "zh-TW": {
      "$ref": "#/components/schemas/group_content",
      "description": "The content of the group in Chinese (Taiwan)"
    }
  },
  "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group."
}

{
  "type": "object",
  "title": "Help Center",
  "x-tags": [
    "Help Center"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123",
      "description": "The unique identifier for the Help Center which is given by Intercom."
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1672928359,
      "description": "The time when the Help Center was created."
    },
    "identifier": {
      "type": "string",
      "example": "intercom",
      "description": "The identifier of the Help Center. This is used in the URL of the Help Center."
    },
    "updated_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1672928610,
      "description": "The time when the Help Center was last updated."
    },
    "display_name": {
      "type": "string",
      "example": "Intercom Help Center",
      "description": "The display name of the Help Center only seen by teammates."
    },
    "workspace_id": {
      "type": "string",
      "example": "hfi1bx4l",
      "description": "The id of the workspace which the Help Center belongs to."
    },
    "website_turned_on": {
      "type": "boolean",
      "example": true,
      "description": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings."
    }
  },
  "description": "Help Centers contain collections"
}

{
  "type": "object",
  "title": "Help Centers",
  "x-tags": [
    "Help Center"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/help_center"
      },
      "description": "An array of Help Center objects"
    },
    "type": {
      "enum": [
        "list"
      ],
      "type": "string",
      "example": "list",
      "description": "The type of the object - `list`."
    }
  },
  "description": "A list of Help Centers belonging to the App"
}

{
  "enum": [
    "1.0",
    "1.1",
    "1.2",
    "1.3",
    "1.4",
    "2.0",
    "2.1",
    "2.2",
    "2.3",
    "2.4",
    "2.5",
    "2.6",
    "2.7",
    "2.8",
    "2.9",
    "2.10",
    "Unstable"
  ],
  "type": "string",
  "default": "2.9",
  "example": "2.9",
  "description": "Intercom API version.</br>By default, it's equal to the version set in the app package."
}

{
  "type": "object",
  "title": "Merge contact data",
  "properties": {
    "from": {
      "type": "string",
      "example": "5d70dd30de4efd54f42fd526",
      "description": "The unique identifier for the contact to merge away from. Must be a lead."
    },
    "into": {
      "type": "string",
      "example": "5ba682d23d7cf92bef87bfd4",
      "description": "The unique identifier for the contact to merge into. Must be a user."
    }
  },
  "description": "Merge contact data."
}

{
  "type": "object",
  "title": "Message",
  "x-tags": [
    "Messages"
  ],
  "required": [
    "type",
    "id",
    "created_at",
    "body",
    "message_type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "1488971108",
      "description": "The id representing the message."
    },
    "body": {
      "type": "string",
      "example": "Hello",
      "description": "The message body, which may contain HTML."
    },
    "type": {
      "type": "string",
      "example": "user_message",
      "description": "The type of the message"
    },
    "subject": {
      "type": "string",
      "example": "Greetings",
      "description": "The subject of the message. Only present if message_type: email."
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1667560812,
      "description": "The time the conversation was created."
    },
    "message_type": {
      "enum": [
        "email",
        "inapp",
        "facebook",
        "twitter"
      ],
      "type": "string",
      "example": "inapp",
      "description": "The type of message that was sent. Can be email, inapp, facebook or twitter."
    },
    "conversation_id": {
      "type": "string",
      "example": "64619700005570",
      "description": "The associated conversation_id"
    }
  },
  "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact."
}

{
  "type": "object",
  "properties": {
    "value": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/multiple_filter_search_request"
          },
          "title": "multiple filter search request",
          "description": "Add mutiple filters."
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/single_filter_search_request"
          },
          "title": "single filter search request",
          "description": "Add a single filter field."
        }
      ]
    },
    "operator": {
      "enum": [
        "AND",
        "OR"
      ],
      "type": "string",
      "example": "AND",
      "description": "An operator to allow boolean inspection between multiple fields."
    }
  }
}

{
  "type": "object",
  "title": "News Item",
  "x-tags": [
    "News"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "141",
      "description": "The unique identifier for the news item which is given by Intercom."
    },
    "body": {
      "type": "string",
      "example": "We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.",
      "description": "The news item body, which may contain HTML."
    },
    "type": {
      "enum": [
        "news-item"
      ],
      "type": "string",
      "example": "news-item",
      "description": "The type of object."
    },
    "state": {
      "enum": [
        "draft",
        "live"
      ],
      "type": "string",
      "example": "live",
      "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live."
    },
    "title": {
      "type": "string",
      "example": "New feature: News Items",
      "description": "The title of the news item."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "Product Update",
        "nullable": true,
        "description": "The label name."
      },
      "description": "Label names displayed to users to categorize the news item."
    },
    "reactions": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "👍",
        "nullable": true,
        "description": "The emoji reaction to the news item."
      },
      "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled."
    },
    "sender_id": {
      "type": "integer",
      "example": 123,
      "description": "The id of the sender of the news item. Must be a teammate on the workspace."
    },
    "created_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1610589632,
      "description": "Timestamp for when the news item was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1610589632,
      "description": "Timestamp for when the news item was last updated."
    },
    "workspace_id": {
      "type": "string",
      "example": "t74hdn32",
      "description": "The id of the workspace which the news item belongs to."
    },
    "cover_image_url": {
      "type": "string",
      "format": "uri",
      "example": "https://example.com/cover.jpg",
      "nullable": true,
      "description": "URL of the image used as cover. Must have .jpg or .png extension."
    },
    "deliver_silently": {
      "type": "boolean",
      "example": true,
      "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge."
    },
    "newsfeed_assignments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/newsfeed_assignment"
      },
      "description": "A list of newsfeed_assignments to assign to the specified newsfeed."
    }
  },
  "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers."
}

{
  "type": "object",
  "title": "Create News Item Request",
  "required": [
    "title",
    "sender_id"
  ],
  "properties": {
    "body": {
      "type": "string",
      "example": "<p>New costumes in store for this spooky season</p>",
      "description": "The news item body, which may contain HTML."
    },
    "state": {
      "enum": [
        "draft",
        "live"
      ],
      "type": "string",
      "example": "live",
      "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live."
    },
    "title": {
      "type": "string",
      "example": "Halloween is here!",
      "description": "The title of the news item."
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "Product",
        "Update",
        "New"
      ],
      "description": "Label names displayed to users to categorize the news item."
    },
    "reactions": {
      "type": "array",
      "items": {
        "type": "string",
        "nullable": true
      },
      "example": [
        "😆",
        "😅"
      ],
      "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled."
    },
    "sender_id": {
      "type": "integer",
      "example": 123,
      "description": "The id of the sender of the news item. Must be a teammate on the workspace."
    },
    "deliver_silently": {
      "type": "boolean",
      "example": true,
      "description": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge."
    },
    "newsfeed_assignments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/newsfeed_assignment"
      },
      "description": "A list of newsfeed_assignments to assign to the specified newsfeed."
    }
  },
  "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers."
}

{
  "type": "object",
  "title": "Newsfeed",
  "x-tags": [
    "News"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "12312",
      "description": "The unique identifier for the newsfeed which is given by Intercom."
    },
    "name": {
      "type": "string",
      "example": "My Newsfeed",
      "description": "The name of the newsfeed. This name will never be visible to your users."
    },
    "type": {
      "enum": [
        "newsfeed"
      ],
      "type": "string",
      "example": "newsfeed",
      "description": "The type of object."
    },
    "created_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1674917488,
      "description": "Timestamp for when the newsfeed was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1674917488,
      "description": "Timestamp for when the newsfeed was last updated."
    }
  },
  "description": "A newsfeed is a collection of news items, targeted to a specific audience.\n\nNewsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.\n"
}

{
  "type": "object",
  "title": "Newsfeed Assignment",
  "x-tags": [
    "News"
  ],
  "properties": {
    "newsfeed_id": {
      "type": "integer",
      "example": 198313,
      "description": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article)."
    },
    "published_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1674917488,
      "description": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\"."
    }
  },
  "description": "Assigns a news item to a newsfeed."
}

{
  "type": "object",
  "title": "Note",
  "x-tags": [
    "Notes"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "17495962",
      "description": "The id of the note."
    },
    "body": {
      "type": "string",
      "example": "<p>Text for the note.</p>",
      "description": "The body text of the note."
    },
    "type": {
      "type": "string",
      "example": "note",
      "description": "String representing the object's type. Always has the value `note`."
    },
    "author": {
      "$ref": "#/components/schemas/admin",
      "description": "Optional. Represents the Admin that created the note."
    },
    "contact": {
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "string",
          "example": "214656d0c743eafcfde7f248",
          "description": "The id of the contact."
        },
        "type": {
          "type": "string",
          "description": "String representing the object's type. Always has the value `contact`."
        }
      },
      "description": "Represents the contact that the note was created about."
    },
    "created_at": {
      "type": "integer",
      "format": "timestamp",
      "example": 1674589321,
      "description": "The time the note was created."
    }
  },
  "description": "Notes allow you to annotate and comment on your contacts."
}

{
  "type": "object",
  "title": "Paginated Response",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/note"
      },
      "description": "An array of notes."
    },
    "type": {
      "type": "string",
      "example": "list",
      "description": "String representing the object's type. Always has the value `list`."
    },
    "pages": {
      "$ref": "#/components/schemas/cursor_pages"
    },
    "total_count": {
      "type": "integer",
      "example": 1,
      "description": "A count of the total number of notes."
    }
  },
  "description": "A paginated list of notes associated with a contact."
}

{
  "type": "object",
  "title": "Open Conversation Request",
  "required": [
    "message_type",
    "admin_id"
  ],
  "properties": {
    "admin_id": {
      "type": "string",
      "example": "5017690",
      "description": "The id of the admin who is performing the action."
    },
    "message_type": {
      "enum": [
        "open"
      ],
      "type": "string",
      "example": "open"
    }
  },
  "description": "Payload of the request to open a conversation"
}

{
  "type": "object",
  "title": "Pagination Object",
  "properties": {
    "next": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch."
    },
    "page": {
      "type": "integer",
      "example": 1
    },
    "type": {
      "enum": [
        "pages"
      ],
      "type": "string",
      "example": "pages"
    },
    "per_page": {
      "type": "integer",
      "example": 50
    },
    "total_pages": {
      "type": "integer",
      "example": 1
    }
  },
  "description": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n"
}

{
  "type": "object",
  "title": "Paginated Response",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/news_item"
          },
          {
            "$ref": "#/components/schemas/newsfeed"
          }
        ]
      },
      "description": "An array of Objects"
    },
    "type": {
      "enum": [
        "list",
        "conversation.list"
      ],
      "type": "string",
      "example": "list",
      "description": "The type of object"
    },
    "pages": {
      "$ref": "#/components/schemas/cursor_pages"
    },
    "total_count": {
      "type": "integer",
      "example": 1,
      "description": "A count of the total number of objects."
    }
  },
  "description": "Paginated Response"
}

{
  "type": "object",
  "title": "Part attachment",
  "properties": {
    "url": {
      "type": "string",
      "example": "https://picsum.photos/200/300",
      "description": "The URL of the attachment"
    },
    "name": {
      "type": "string",
      "example": "example.png",
      "description": "The name of the attachment"
    },
    "type": {
      "type": "string",
      "example": "upload",
      "description": "The type of attachment"
    },
    "width": {
      "type": "integer",
      "example": 100,
      "description": "The width of the attachment"
    },
    "height": {
      "type": "integer",
      "example": 100,
      "description": "The height of the attachment"
    },
    "filesize": {
      "type": "integer",
      "example": 100,
      "description": "The size of the attachment"
    },
    "content_type": {
      "type": "string",
      "example": "image/png",
      "description": "The content type of the attachment"
    }
  },
  "description": "The file attached to a part"
}

{
  "type": "object",
  "title": "Phone Switch",
  "nullable": true,
  "properties": {
    "type": {
      "enum": [
        "phone_call_redirect"
      ],
      "type": "string",
      "default": "phone_call_redirect",
      "example": "phone_call_redirect",
      "description": ""
    },
    "phone": {
      "type": "string",
      "example": "+1 1234567890",
      "description": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger."
    }
  },
  "description": "Phone Switch Response"
}

{
  "oneOf": [
    {
      "type": "object",
      "title": "Redact Conversation Part Request",
      "required": [
        "type",
        "conversation_id",
        "conversation_part_id"
      ],
      "properties": {
        "type": {
          "enum": [
            "conversation_part"
          ],
          "type": "string",
          "example": "conversation_part",
          "description": "The type of resource being redacted."
        },
        "conversation_id": {
          "type": "string",
          "example": "19894788788",
          "description": "The id of the conversation."
        },
        "conversation_part_id": {
          "type": "string",
          "example": "19381789428",
          "description": "The id of the conversation_part."
        }
      },
      "description": "Payload of the request to redact a conversation part"
    },
    {
      "type": "object",
      "title": "Redact Conversation Source Request",
      "required": [
        "type",
        "conversation_id",
        "source_id"
      ],
      "properties": {
        "type": {
          "enum": [
            "source"
          ],
          "type": "string",
          "example": "source",
          "description": "The type of resource being redacted."
        },
        "source_id": {
          "type": "string",
          "example": "19894781231",
          "description": "The id of the source."
        },
        "conversation_id": {
          "type": "string",
          "example": "19894788788",
          "description": "The id of the conversation."
        }
      },
      "description": "Payload of the request to redact a conversation source"
    }
  ]
}

{
  "type": "object",
  "title": "Reference",
  "properties": {
    "id": {
      "type": "string",
      "example": "1a2b3c",
      "nullable": true,
      "description": ""
    },
    "type": {
      "type": "string",
      "example": "contact",
      "description": ""
    }
  },
  "description": "reference to another object"
}

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/contact_reply_conversation_request"
    },
    {
      "$ref": "#/components/schemas/admin_reply_conversation_request"
    }
  ]
}

{
  "type": "object",
  "title": "Search data",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/single_filter_search_request",
          "title": "Single filter search request"
        },
        {
          "$ref": "#/components/schemas/multiple_filter_search_request",
          "title": "multiple filter search request"
        }
      ]
    },
    "pagination": {
      "$ref": "#/components/schemas/starting_after_paging"
    }
  },
  "description": "Search using Intercoms Search APIs."
}

{
  "type": "object",
  "title": "Section",
  "x-tags": [
    "Help Center"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "6871119",
      "description": "The unique identifier for the section which is given by Intercom."
    },
    "url": {
      "type": "string",
      "example": "http://intercom.test/help/section/name",
      "nullable": true,
      "description": "The URL of the section. For multilingual help centers, this will be the URL of the section for the default language."
    },
    "icon": {
      "type": "string",
      "example": "book-bookmark",
      "nullable": true,
      "description": "The icon of the section."
    },
    "name": {
      "type": "string",
      "example": "Default language name",
      "description": "The name of the section. For multilingual sections, this will be the name of the default language's content."
    },
    "type": {
      "enum": [
        "section"
      ],
      "type": "string",
      "default": "section",
      "example": "section",
      "description": "The type of object - `section`."
    },
    "order": {
      "type": "integer",
      "example": 1,
      "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order."
    },
    "parent_id": {
      "oneOf": [
        {
          "type": "integer",
          "title": "Integer"
        },
        {
          "type": "string",
          "title": "String"
        }
      ],
      "example": 6871119,
      "description": "The id of the parent section."
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1672928359,
      "description": "The time when the section was created. For multilingual sections, this will be the timestamp of creation of the default language's content."
    },
    "updated_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1672928610,
      "description": "The time when the section was last updated. For multilingual sections, this will be the timestamp of last update of the default language's content."
    },
    "workspace_id": {
      "type": "string",
      "example": "hfi1bx4l",
      "description": "The id of the workspace which the section belongs to."
    },
    "default_locale": {
      "type": "string",
      "example": "en",
      "description": "The default locale of the help center. This field is only returned for multilingual help centers."
    },
    "translated_content": {
      "$ref": "#/components/schemas/group_translated_content",
      "nullable": true
    }
  },
  "description": "Sections are subdivisions of a collection, with a collection potentially having multiple sections."
}

{
  "type": "object",
  "title": "Sections",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/section"
      },
      "description": "An array of section objects"
    },
    "type": {
      "enum": [
        "list"
      ],
      "type": "string",
      "example": "list",
      "description": "The type of the object - `list`."
    },
    "pages": {
      "$ref": "#/components/schemas/cursor_pages"
    },
    "total_count": {
      "type": "integer",
      "example": 12,
      "description": "A count of the total number of sections."
    }
  },
  "description": "This will return a list of Sections for the App."
}

{
  "type": "object",
  "title": "Segment",
  "x-tags": [
    "Segments"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "56203d253cba154d39010062",
      "description": "The unique identifier representing the segment."
    },
    "name": {
      "type": "string",
      "example": "Active",
      "description": "The name of the segment."
    },
    "type": {
      "enum": [
        "segment"
      ],
      "type": "string",
      "example": "segment",
      "description": "The type of object."
    },
    "count": {
      "type": "integer",
      "example": 3,
      "nullable": true,
      "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request."
    },
    "created_at": {
      "type": "integer",
      "example": 1394621988,
      "description": "The time the segment was created."
    },
    "updated_at": {
      "type": "integer",
      "example": 1394622004,
      "description": "The time the segment was updated."
    },
    "person_type": {
      "enum": [
        "contact",
        "user"
      ],
      "type": "string",
      "example": "contact",
      "description": "Type of the contact: contact (lead) or user."
    }
  },
  "description": "A segment is a group of your contacts defined by the rules that you set."
}

{
  "type": "object",
  "title": "Segment List",
  "properties": {
    "type": {
      "enum": [
        "segment.list"
      ],
      "type": "string",
      "example": "segment.list",
      "description": "The type of the object"
    },
    "pages": {
      "type": "object",
      "description": "A pagination object, which may be empty, indicating no further pages to fetch."
    },
    "segments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/segment"
      },
      "description": "A list of Segment objects"
    }
  },
  "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated."
}

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "custom_attributes.social_network",
      "description": "The Intercom defined id representing the company."
    },
    "value": {
      "type": "string",
      "example": "facebook",
      "description": "The Intercom defined id representing the company."
    },
    "operator": {
      "enum": [
        "=",
        "!=",
        "IN",
        "NIN",
        "<",
        ">",
        "~",
        "!~",
        "^",
        "$"
      ],
      "type": "string",
      "example": "=",
      "description": "The Intercom defined id representing the company."
    }
  }
}

{
  "type": "object",
  "title": "Applied SLA",
  "nullable": true,
  "properties": {
    "type": {
      "type": "string",
      "example": "conversation_sla_summary",
      "description": "object type"
    },
    "sla_name": {
      "type": "string",
      "example": "",
      "description": "The name of the SLA as given by the teammate when it was created."
    },
    "sla_status": {
      "enum": [
        "hit",
        "missed",
        "cancelled",
        "active"
      ],
      "type": "string",
      "example": "hit",
      "description": "SLA statuses:\n            - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.\n            - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.\n            - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events."
    }
  },
  "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n"
}

{
  "type": "object",
  "title": "Snooze Conversation Request",
  "required": [
    "message_type",
    "admin_id",
    "snoozed_until"
  ],
  "properties": {
    "admin_id": {
      "type": "string",
      "example": "5017691",
      "description": "The id of the admin who is performing the action."
    },
    "message_type": {
      "enum": [
        "snoozed"
      ],
      "type": "string",
      "example": "snoozed"
    },
    "snoozed_until": {
      "type": "integer",
      "format": "timestamp",
      "example": 1673609604,
      "description": "The time you want the conversation to reopen."
    }
  },
  "description": "Payload of the request to snooze a conversation"
}

{
  "type": "object",
  "title": "Social Profile",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "http://twitter.com/th1sland",
      "description": "The name of the Social media profile"
    },
    "name": {
      "type": "string",
      "example": "Facebook",
      "description": "The name of the Social media profile"
    },
    "type": {
      "type": "string",
      "example": "social_profile",
      "description": "value is \"social_profile\""
    }
  },
  "description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile."
}

{
  "type": "object",
  "title": "StartingAfterPaging",
  "nullable": true,
  "properties": {
    "page": {
      "type": "integer",
      "example": 2
    },
    "starting_after": {
      "type": "string",
      "example": "1HaSB+xrOyyMXAkS/c1RteCL7BzOzTvYjmjakgTergIH31eoe2v4/sbLsJWP\\nIncfQLD3ouPkZlCwJ86F\\n"
    }
  }
}

{
  "type": "object",
  "title": "Subscription Types",
  "x-tags": [
    "Subscription Types"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123456",
      "description": "The unique identifier representing the subscription type."
    },
    "type": {
      "type": "string",
      "example": "subscription",
      "description": "The type of the object - subscription"
    },
    "state": {
      "enum": [
        "live",
        "draft",
        "archived"
      ],
      "type": "string",
      "example": "live",
      "description": "The state of the subscription type."
    },
    "consent_type": {
      "enum": [
        "opt_out",
        "opt_in"
      ],
      "type": "string",
      "example": "opt_in",
      "description": "Describes the type of consent."
    },
    "translations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/translation"
      },
      "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings."
    },
    "content_types": {
      "type": "array",
      "items": {
        "enum": [
          "email",
          "sms_message"
        ],
        "type": "string",
        "example": "email"
      },
      "description": "The message types that this subscription supports - can contain `email` or `sms_message`."
    },
    "default_translation": {
      "$ref": "#/components/schemas/translation"
    }
  },
  "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them."
}

{
  "type": "object",
  "title": "Subscription Types",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/subscription_type"
      },
      "description": "A list of subscription type objects associated with the workspace ."
    },
    "type": {
      "enum": [
        "list"
      ],
      "type": "string",
      "example": "list",
      "description": "The type of the object"
    }
  },
  "description": "A list of subscription type objects."
}

{
  "type": "object",
  "title": "Tag",
  "x-tags": [
    "Tags"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "123456",
      "description": "The id of the tag"
    },
    "name": {
      "type": "string",
      "example": "Test tag",
      "description": "The name of the tag"
    },
    "type": {
      "type": "string",
      "example": "tag",
      "description": "value is \"tag\""
    },
    "applied_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597223,
      "description": "The time when the tag was applied to the object"
    },
    "applied_by": {
      "$ref": "#/components/schemas/reference"
    }
  },
  "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag."
}

{
  "type": "object",
  "title": "Tag Company Request Payload",
  "required": [
    "name",
    "companies"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Independent",
      "description": "The name of the tag, which will be created if not found."
    },
    "companies": {
      "type": "array",
      "items": {
        "properties": {
          "id": {
            "type": "string",
            "example": "531ee472cce572a6ec000006",
            "description": "The Intercom defined id representing the company."
          },
          "company_id": {
            "type": "string",
            "example": "6",
            "description": "The company id you have defined for the company."
          }
        }
      },
      "description": "The id or company_id of the company can be passed as input parameters."
    }
  },
  "description": "You can tag a single company or a list of companies."
}

{
  "type": "object",
  "title": "Tags",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tag"
      },
      "description": "A list of tags objects associated with the workspace ."
    },
    "type": {
      "enum": [
        "list"
      ],
      "type": "string",
      "example": "list",
      "description": "The type of the object"
    }
  },
  "description": "A list of tags objects in the workspace."
}

{
  "type": "object",
  "title": "Tag Users Request Payload",
  "required": [
    "name",
    "users"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Independent",
      "description": "The name of the tag, which will be created if not found."
    },
    "users": {
      "type": "array",
      "items": {
        "properties": {
          "id": {
            "type": "string",
            "example": "5f7f0d217289f8d2f4262080",
            "description": "The Intercom defined id representing the user."
          }
        }
      }
    }
  },
  "description": "You can tag a list of users."
}

{
  "type": "object",
  "title": "Tags",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tag"
      },
      "description": "A list of tags objects associated with the conversation."
    },
    "type": {
      "enum": [
        "tag.list"
      ],
      "type": "string",
      "example": "tag.list",
      "description": "The type of the object"
    }
  },
  "description": "A list of tags objects associated with a conversation"
}

{
  "type": "object",
  "title": "Team",
  "x-tags": [
    "Teams"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "814865",
      "description": "The id of the team"
    },
    "name": {
      "type": "string",
      "example": "Example Team",
      "description": "The name of the team"
    },
    "type": {
      "type": "string",
      "example": "team",
      "description": "Value is always \"team\""
    },
    "admin_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "example": [
        493881
      ],
      "description": "The list of admin IDs that are a part of the team."
    },
    "admin_priority_level": {
      "$ref": "#/components/schemas/admin_priority_level"
    }
  },
  "description": "Teams are groups of admins in Intercom."
}

{
  "type": "object",
  "title": "Team List",
  "properties": {
    "type": {
      "enum": [
        "team.list"
      ],
      "type": "string",
      "example": "team.list",
      "description": "The type of the object"
    },
    "teams": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/team"
      },
      "description": "A list of team objects"
    }
  },
  "description": "This will return a list of team objects for the App."
}

{
  "type": "object",
  "title": "Team Priority Level",
  "nullable": true,
  "properties": {
    "primary_team_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "example": [
        814865
      ],
      "nullable": true,
      "description": "The primary team ids for the team"
    },
    "secondary_team_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "example": [
        493881
      ],
      "nullable": true,
      "description": "The secondary team ids for the team"
    }
  },
  "description": "Admin priority levels for teams"
}

{
  "type": "object",
  "title": "Ticket",
  "x-tags": [
    "Tickets"
  ],
  "nullable": true,
  "properties": {
    "id": {
      "type": "string",
      "example": "1295",
      "description": "The unique identifier for the ticket which is given by Intercom."
    },
    "type": {
      "enum": [
        "ticket"
      ],
      "type": "string",
      "default": "ticket",
      "example": "ticket",
      "description": "Always ticket"
    },
    "contacts": {
      "$ref": "#/components/schemas/ticket_contacts"
    },
    "is_shared": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the ticket is shared with the customer."
    },
    "ticket_id": {
      "type": "string",
      "example": "1390",
      "description": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries."
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597223,
      "description": "The time the ticket was created as a UTC Unix timestamp."
    },
    "updated_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597260,
      "description": "The last time the ticket was updated as a UTC Unix timestamp."
    },
    "ticket_type": {
      "$ref": "#/components/schemas/ticket_type"
    },
    "ticket_parts": {
      "$ref": "#/components/schemas/ticket_parts"
    },
    "ticket_state": {
      "enum": [
        "submitted",
        "in_progress",
        "waiting_on_customer",
        "resolved"
      ],
      "type": "string",
      "example": "submitted",
      "description": "The state the ticket is currenly in"
    },
    "team_assignee_id": {
      "type": "string",
      "example": "1295",
      "description": "The id representing the team assigned to the ticket."
    },
    "admin_assignee_id": {
      "type": "string",
      "example": "1295",
      "description": "The id representing the admin assigned to the ticket."
    },
    "ticket_attributes": {
      "$ref": "#/components/schemas/ticket_custom_attributes"
    },
    "ticket_state_external_label": {
      "type": "string",
      "description": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal."
    },
    "ticket_state_internal_label": {
      "type": "string",
      "description": "The state the ticket is currently in, in a human readable form - visible in Intercom"
    }
  },
  "description": "Tickets are how you track requests from your users."
}

{
  "type": "object",
  "title": "Contacts",
  "x-tags": [
    "Tickets"
  ],
  "properties": {
    "type": {
      "enum": [
        "contact.list"
      ],
      "type": "string",
      "example": "contact.list",
      "description": "always contact.list"
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact_reference"
      },
      "description": "The list of contacts affected by this ticket."
    }
  },
  "description": "The list of contacts affected by a ticket."
}

{
  "type": "object",
  "title": "Ticket Attributes",
  "example": {
    "_default_title_": "Found a bug",
    "_default_description_": "The button's not working"
  },
  "description": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.",
  "additionalProperties": {
    "anyOf": [
      {
        "type": "string",
        "nullable": true
      },
      {
        "type": "number"
      },
      {
        "type": "boolean"
      },
      {
        "type": "array",
        "items": {
          "description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
        }
      },
      {
        "$ref": "#/components/schemas/file_attribute"
      }
    ]
  }
}

{
  "type": "object",
  "title": "A Ticket Part representing a note",
  "properties": {
    "id": {
      "type": "string",
      "example": "3",
      "description": "The id representing the note."
    },
    "body": {
      "type": "string",
      "example": "<p>Okay!</p>",
      "nullable": true,
      "description": "The message body, which may contain HTML."
    },
    "type": {
      "enum": [
        "ticket_part"
      ],
      "type": "string",
      "example": "ticket_part",
      "description": "Always ticket_part"
    },
    "author": {
      "$ref": "#/components/schemas/ticket_part_author"
    },
    "redacted": {
      "type": "boolean",
      "example": false,
      "description": "Whether or not the ticket part has been redacted."
    },
    "part_type": {
      "enum": [
        "note"
      ],
      "type": "string",
      "example": "note",
      "description": "Always note"
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597223,
      "description": "The time the note was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597260,
      "description": "The last time the note was updated."
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/part_attachment"
      },
      "title": "Ticket part attachments",
      "description": "A list of attachments for the part."
    }
  },
  "description": "A Ticket Part representing a note in the ticket"
}