object ticket_part
{
  "type": "object",
  "title": "Ticket Part",
  "x-tags": [
    "Tickets"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "3",
      "description": "The id representing the ticket part."
    },
    "body": {
      "type": "string",
      "example": "<p>Okay!</p>",
      "nullable": true,
      "description": "The message body, which may contain HTML."
    },
    "type": {
      "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": {
      "type": "string",
      "example": "comment",
      "description": "The type of ticket part."
    },
    "created_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597223,
      "description": "The time the ticket part was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1663597260,
      "description": "The last time the ticket part was updated."
    },
    "assigned_to": {
      "$ref": "#/components/schemas/reference",
      "nullable": true,
      "description": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)"
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/part_attachment"
      },
      "title": "Ticket part attachments",
      "description": "A list of attachments for the part."
    },
    "external_id": {
      "type": "string",
      "example": "abcd1234",
      "nullable": true,
      "description": "The external id of the ticket part"
    },
    "ticket_state": {
      "enum": [
        "submitted",
        "in_progress",
        "waiting_on_customer",
        "resolved"
      ],
      "type": "string",
      "example": "submitted",
      "description": "The state of the ticket."
    },
    "previous_ticket_state": {
      "enum": [
        "submitted",
        "in_progress",
        "waiting_on_customer",
        "resolved"
      ],
      "type": "string",
      "example": "submitted",
      "description": "The previous state of the ticket."
    }
  },
  "description": "A Ticket Part represents a message in the ticket."
}
object ticket_part_author
{
  "type": "object",
  "title": "Ticket part author",
  "properties": {
    "id": {
      "type": "string",
      "example": "274",
      "description": "The id of the author"
    },
    "name": {
      "type": "string",
      "example": "Operator",
      "nullable": true,
      "description": "The name of the author"
    },
    "type": {
      "enum": [
        "admin",
        "bot",
        "team"
      ],
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "operator+abcd1234@intercom.io",
      "description": "The email of the author"
    }
  },
  "description": "The author that wrote or triggered the part. Can be a bot, admin, team or user."
}
object ticket_parts
{
  "type": "object",
  "title": "Ticket Parts",
  "properties": {
    "type": {
      "enum": [
        "ticket_part.list"
      ],
      "type": "string",
      "example": "ticket_part.list",
      "description": ""
    },
    "total_count": {
      "type": "integer",
      "example": 2,
      "description": ""
    },
    "ticket_parts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ticket_part"
      },
      "title": "Tickt Parts",
      "description": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts."
    }
  },
  "description": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts."
}
object ticket_request_custom_attributes
{
  "type": "object",
  "title": "Ticket Attributes",
  "example": {
    "_default_title_": "Found a bug",
    "_default_description_": "The button is not working"
  },
  "description": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).",
  "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."
        }
      }
    ]
  }
}
object ticket_type
{
  "type": "object",
  "title": "Ticket Type",
  "x-tags": [
    "Tickets"
  ],
  "nullable": true,
  "properties": {
    "id": {
      "type": "string",
      "example": "1295",
      "description": "The id representing the ticket type."
    },
    "icon": {
      "type": "string",
      "example": "🐞",
      "description": "The icon of the ticket type"
    },
    "name": {
      "type": "string",
      "example": "Bug",
      "description": "The name of the ticket type"
    },
    "type": {
      "type": "string",
      "example": "ticket_type",
      "description": "String representing the object's type. Always has the value `ticket_type`."
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "Whether the ticket type is archived or not."
    },
    "created_at": {
      "type": "integer",
      "format": "timestamp",
      "description": "The date and time the ticket type was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "timestamp",
      "description": "The date and time the ticket type was last updated."
    },
    "description": {
      "type": "string",
      "example": "A bug that has been reported.",
      "description": "The description of the ticket type"
    },
    "workspace_id": {
      "type": "string",
      "example": "ecahpwf5",
      "description": "The id of the workspace that the ticket type belongs to."
    },
    "ticket_type_attributes": {
      "$ref": "#/components/schemas/ticket_type_attribute_list"
    }
  },
  "description": "A ticket type, used to define the data fields to be captured in a ticket."
}
object ticket_type_attribute
{
  "type": "object",
  "title": "Ticket Type Attribute",
  "nullable": true,
  "properties": {
    "id": {
      "type": "string",
      "example": "1",
      "description": "The id representing the ticket type attribute."
    },
    "name": {
      "type": "string",
      "example": "Title",
      "description": "The name of the ticket type attribute"
    },
    "type": {
      "type": "string",
      "example": "ticket_type_attribute",
      "description": "String representing the object's type. Always has the value `ticket_type_attribute`."
    },
    "order": {
      "type": "integer",
      "example": 1,
      "description": "The order of the attribute against other attributes"
    },
    "default": {
      "type": "boolean",
      "example": true,
      "description": "Whether the attribute is built in or not."
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "Whether the ticket type attribute is archived or not."
    },
    "data_type": {
      "type": "string",
      "example": "string",
      "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")"
    },
    "created_at": {
      "type": "integer",
      "format": "timestamp",
      "description": "The date and time the ticket type attribute was created."
    },
    "updated_at": {
      "type": "integer",
      "format": "timestamp",
      "description": "The date and time the ticket type attribute was last updated."
    },
    "description": {
      "type": "string",
      "example": "Bug title.",
      "description": "The description of the ticket type attribute"
    },
    "workspace_id": {
      "type": "string",
      "example": "ecahpwf5",
      "description": "The id of the workspace that the ticket type attribute belongs to."
    },
    "input_options": {
      "type": "object",
      "example": "multiline: true",
      "description": "Input options for the attribute"
    },
    "ticket_type_id": {
      "type": "integer",
      "example": 42,
      "description": "The id of the ticket type that the attribute belongs to."
    },
    "visible_on_create": {
      "type": "boolean",
      "default": true,
      "example": false,
      "description": "Whether the attribute is visible or not to teammates."
    },
    "required_to_create": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the attribute is required or not for teammates."
    },
    "visible_to_contacts": {
      "type": "boolean",
      "default": true,
      "example": false,
      "description": "Whether the attribute is visible or not to contacts."
    },
    "required_to_create_for_contacts": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the attribute is required or not for contacts."
    }
  },
  "description": "Ticket type attribute, used to define each data field to be captured in a ticket."
}
object ticket_type_attribute_list
{
  "type": "object",
  "title": "Ticket Type Attributes",
  "properties": {
    "type": {
      "type": "string",
      "description": "String representing the object's type. Always has the value `ticket_type_attributes.list`."
    },
    "ticket_type_attributes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ticket_type_attribute"
      },
      "description": "A list of ticket type attributes associated with a given ticket type."
    }
  },
  "description": "A list of attributes associated with a given ticket type."
}
object ticket_type_list
{
  "type": "object",
  "title": "Ticket Types",
  "properties": {
    "type": {
      "type": "string",
      "description": "String representing the object's type. Always has the value `ticket_type.list`."
    },
    "ticket_types": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ticket_type"
      },
      "description": "A list of ticket_types associated with a given workspace."
    }
  },
  "description": "A list of ticket types associated with a given workspace."
}
object translation
{
  "type": "object",
  "title": "Translation",
  "properties": {
    "name": {
      "type": "string",
      "example": "Announcements",
      "description": "The localised name of the subscription type."
    },
    "locale": {
      "type": "string",
      "example": "en",
      "description": "The two character identifier for the language of the translation object."
    },
    "description": {
      "type": "string",
      "example": "Offers, product and feature announcements",
      "description": "The localised description of the subscription type."
    }
  },
  "description": "A translation object contains the localised details of a subscription type."
}
object untag_company_request
{
  "type": "object",
  "title": "Untag Company Request Payload",
  "required": [
    "name",
    "companies"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "Independent",
      "description": "The name of the tag which will be untagged from the company"
    },
    "companies": {
      "type": "array",
      "items": {
        "properties": {
          "id": {
            "type": "string",
            "example": "531ee472cce572a6ec000006",
            "description": "The Intercom defined id representing the company."
          },
          "untag": {
            "type": "boolean",
            "example": true,
            "description": "Always set to true"
          },
          "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."
}
object update_article_request
{
  "type": "object",
  "title": "Update Article Request Payload",
  "nullable": true,
  "properties": {
    "body": {
      "type": "string",
      "example": "<p>This is the body in html</p>",
      "description": "The content of the article. For multilingual articles, this will be the body of the default language's content."
    },
    "state": {
      "enum": [
        "published",
        "draft"
      ],
      "type": "string",
      "example": "draft",
      "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content."
    },
    "title": {
      "type": "string",
      "example": "Thanks for everything",
      "description": "The title of the article.For multilingual articles, this will be the title of the default language's content."
    },
    "author_id": {
      "type": "integer",
      "example": 1295,
      "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace."
    },
    "parent_id": {
      "type": "string",
      "example": "18",
      "description": "The id of the article's parent collection or section. An article without this field stands alone."
    },
    "description": {
      "type": "string",
      "example": "Description of the Article",
      "description": "The description of the article. For multilingual articles, this will be the description of the default language's content."
    },
    "parent_type": {
      "type": "string",
      "example": "collection",
      "description": "The type of parent, which can either be a `collection` or `section`."
    },
    "translated_content": {
      "$ref": "#/components/schemas/article_translated_content"
    }
  },
  "description": "You can Update an Article"
}
object update_collection_request
{
  "type": "object",
  "title": "Update Collection Request Payload",
  "properties": {
    "name": {
      "type": "string",
      "example": "collection 51",
      "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content."
    },
    "description": {
      "type": "string",
      "example": "English description",
      "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content."
    },
    "translated_content": {
      "$ref": "#/components/schemas/group_translated_content",
      "nullable": true
    }
  },
  "description": "You can update a collection"
}
object update_contact_request
{
  "type": "object",
  "title": "Update Contact Request Payload",
  "properties": {
    "name": {
      "type": "string",
      "example": "John Doe",
      "nullable": true,
      "description": "The contacts name"
    },
    "role": {
      "type": "string",
      "description": "The role of the contact."
    },
    "email": {
      "type": "string",
      "example": "jdoe@example.com",
      "description": "The contacts email"
    },
    "phone": {
      "type": "string",
      "example": "+353871234567",
      "nullable": true,
      "description": "The contacts phone"
    },
    "avatar": {
      "type": "string",
      "example": "https://www.example.com/avatar_image.jpg",
      "nullable": true,
      "description": "An image URL containing the avatar of a contact"
    },
    "owner_id": {
      "type": "integer",
      "example": 123,
      "nullable": true,
      "description": "The id of an admin that has been assigned account ownership of the contact"
    },
    "external_id": {
      "type": "string",
      "description": "A unique identifier for the contact which is given to Intercom"
    },
    "last_seen_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1571672154,
      "nullable": true,
      "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)"
    },
    "signed_up_at": {
      "type": "integer",
      "format": "date-time",
      "example": 1571672154,
      "nullable": true,
      "description": "The time specified for when a contact signed up"
    },
    "custom_attributes": {
      "type": "object",
      "nullable": true,
      "description": "The custom attributes which are set for the contact"
    },
    "unsubscribed_from_emails": {
      "type": "boolean",
      "example": true,
      "nullable": true,
      "description": "Whether the contact is unsubscribed from emails"
    }
  },
  "description": "You can update a contact"
}
object update_conversation_request
{
  "type": "object",
  "title": "Update Conversation Request",
  "properties": {
    "read": {
      "type": "boolean",
      "example": true,
      "description": "Mark a conversation as read within Intercom."
    },
    "custom_attributes": {
      "$ref": "#/components/schemas/custom_attributes"
    }
  },
  "description": "Payload of the request to update a conversation"
}
object update_data_attribute_request
{
  "type": "object",
  "title": "Update Data Attribute Request",
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "option1",
        "option2"
      ],
      "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`."
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "Whether the attribute is to be archived or not."
    },
    "description": {
      "type": "string",
      "example": "My Data Attribute Description",
      "description": "The readable description you see in the UI for the attribute."
    },
    "messenger_writable": {
      "type": "boolean",
      "example": false,
      "description": "Can this attribute be updated by the Messenger"
    }
  },
  "description": ""
}
object update_section_request
{
  "type": "object",
  "title": "Update Section Request Payload",
  "properties": {
    "name": {
      "type": "string",
      "example": "Section 51",
      "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content."
    },
    "parent_id": {
      "type": "integer",
      "example": 18,
      "description": "The id for the collection this section will be within."
    },
    "translated_content": {
      "$ref": "#/components/schemas/group_translated_content",
      "nullable": true
    }
  },
  "description": "You can update a Section"
}
object update_ticket_request
{
  "type": "object",
  "title": "Update Ticket Request Payload",
  "properties": {
    "state": {
      "enum": [
        "in_progress",
        "waiting_on_customer",
        "resolved"
      ],
      "type": "string",
      "example": "submitted",
      "description": "The state of the ticket."
    },
    "is_shared": {
      "type": "boolean",
      "example": true,
      "description": "Specify whether the ticket is visible to users."
    },
    "assignment": {
      "type": "object",
      "properties": {
        "admin_id": {
          "type": "string",
          "example": "123",
          "description": "The ID of the admin performing the action."
        },
        "assignee_id": {
          "type": "string",
          "example": "123",
          "description": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it."
        }
      }
    },
    "ticket_attributes": {
      "type": "object",
      "example": {
        "title": "example",
        "description": "having a problem"
      },
      "description": "The attributes set on the ticket."
    }
  },
  "description": "You can update a Ticket"
}
object update_ticket_type_attribute_request
{
  "type": "object",
  "title": "Update Ticket Type Attribute Request Payload",
  "properties": {
    "name": {
      "type": "string",
      "example": "Bug Priority",
      "description": "The name of the ticket type attribute"
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)"
    },
    "multiline": {
      "type": "boolean",
      "example": false,
      "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)"
    },
    "list_items": {
      "type": "string",
      "example": "Low Priority,Medium Priority,High Priority",
      "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)"
    },
    "description": {
      "type": "string",
      "example": "Priority level of the bug",
      "description": "The description of the attribute presented to the teammate or contact"
    },
    "visible_on_create": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox."
    },
    "required_to_create": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox."
    },
    "visible_to_contacts": {
      "type": "boolean",
      "default": true,
      "example": true,
      "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger."
    },
    "allow_multiple_values": {
      "type": "boolean",
      "example": false,
      "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)"
    },
    "required_to_create_for_contacts": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger."
    }
  },
  "description": "You can update a Ticket Type Attribute"
}
object update_ticket_type_request
{
  "type": "object",
  "title": "Update Ticket Type Request Payload",
  "nullable": true,
  "properties": {
    "icon": {
      "type": "string",
      "default": "🎟️",
      "example": "🐞",
      "description": "The icon of the ticket type."
    },
    "name": {
      "type": "string",
      "example": "Bug",
      "description": "The name of the ticket type."
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "The archived status of the ticket type."
    },
    "description": {
      "type": "string",
      "example": "A bug has been occured",
      "description": "The description of the ticket type."
    },
    "is_internal": {
      "type": "boolean",
      "default": false,
      "example": false,
      "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute."
    }
  },
  "description": "The request payload for updating a ticket type.\nYou can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n"
}
object update_visitor_request
{
  "type": "object",
  "anyOf": [
    {
      "required": [
        "id"
      ]
    },
    {
      "required": [
        "user_id"
      ]
    }
  ],
  "title": "Update Visitor Request Payload",
  "properties": {
    "id": {
      "type": "string",
      "example": "8a88a590-e",
      "description": "A unique identified for the visitor which is given by Intercom."
    },
    "name": {
      "type": "string",
      "example": "Christian Bale",
      "description": "The visitor's name."
    },
    "user_id": {
      "type": "string",
      "example": "123",
      "description": "A unique identified for the visitor which is given by you."
    },
    "custom_attributes": {
      "type": "object",
      "example": {
        "team_mates": 9,
        "monthly_spend": 155.5,
        "paid_subscriber": true
      },
      "description": "The custom attributes which are set for the visitor.",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "description": "Update an existing visitor."
}
object visitor
{
  "type": "object",
  "title": "Visitor",
  "nullable": true,
  "properties": {
    "id": {
      "type": "string",
      "example": "530370b477ad7120001d",
      "description": "The Intercom defined id representing the Visitor."
    },
    "name": {
      "type": "string",
      "example": "Jane Doe",
      "nullable": true,
      "description": "The name of the visitor."
    },
    "tags": {
      "type": "object",
      "properties": {
        "tags": {
          "type": "array",
          "items": {
            "properties": {
              "id": {
                "type": "string",
                "example": "8482",
                "description": "The id of the tag."
              },
              "name": {
                "type": "string",
                "example": "tag_name",
                "description": "The name of the tag."
              },
              "type": {
                "enum": [
                  "tag"
                ],
                "type": "string",
                "example": "tag",
                "description": "The type of the object"
              }
            }
          }
        },
        "type": {
          "enum": [
            "tag.list"
          ],
          "type": "string",
          "example": "tag.list",
          "description": "The type of the object"
        }
      }
    },
    "type": {
      "type": "string",
      "default": "visitor",
      "example": "visitor",
      "description": "Value is 'visitor'"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "jane.doe@example.com",
      "description": "The email of the visitor."
    },
    "phone": {
      "type": "string",
      "example": "555-555-5555",
      "nullable": true,
      "description": "The phone number of the visitor."
    },
    "app_id": {
      "type": "string",
      "example": "hfi1bx4l",
      "description": "The id of the app the visitor is associated with."
    },
    "avatar": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "default": "avatar",
          "example": "avatar",
          "description": ""
        },
        "image_url": {
          "type": "string",
          "format": "uri",
          "example": "https://example.com/avatar.png",
          "nullable": true,
          "description": "This object represents the avatar associated with the visitor."
        }
      }
    },
    "user_id": {
      "type": "string",
      "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
      "description": "Automatically generated identifier for the Visitor."
    },
    "owner_id": {
      "type": "string",
      "example": "5169261",
      "nullable": true,
      "description": "The id of the admin that owns the Visitor."
    },
    "referrer": {
      "type": "string",
      "example": "https://www.google.com/",
      "nullable": true,
      "description": "The referer of the visitor."
    },
    "segments": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "segment.list"
          ],
          "type": "string",
          "example": "segment.list",
          "description": "The type of the object"
        },
        "segments": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "utm_term": {
      "type": "string",
      "example": "messenger",
      "nullable": true,
      "description": "The utm_term of the visitor."
    },
    "anonymous": {
      "type": "boolean",
      "example": false,
      "description": "Identifies if this visitor is anonymous."
    },
    "companies": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "company.list"
          ],
          "type": "string",
          "example": "company.list",
          "description": "The type of the object"
        },
        "companies": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/company"
          }
        }
      }
    },
    "pseudonym": {
      "type": "string",
      "example": "Red Duck from Dublin",
      "nullable": true,
      "description": "The pseudonym of the visitor."
    },
    "created_at": {
      "type": "integer",
      "example": 1663597223,
      "description": "The time the Visitor was added to Intercom."
    },
    "updated_at": {
      "type": "integer",
      "example": 1663597260,
      "description": "The last time the Visitor was updated."
    },
    "utm_medium": {
      "type": "string",
      "example": "email",
      "nullable": true,
      "description": "The utm_medium of the visitor."
    },
    "utm_source": {
      "type": "string",
      "example": "Intercom",
      "nullable": true,
      "description": "The utm_source of the visitor."
    },
    "utm_content": {
      "type": "string",
      "example": "banner",
      "nullable": true,
      "description": "The utm_content of the visitor."
    },
    "do_not_track": {
      "type": "boolean",
      "example": false,
      "nullable": true,
      "description": "Identifies if this visitor has do not track enabled."
    },
    "signed_up_at": {
      "type": "integer",
      "example": 1663597223,
      "description": "The time the Visitor signed up for your product."
    },
    "utm_campaign": {
      "type": "string",
      "example": "intercom-link",
      "nullable": true,
      "description": "The utm_campaign of the visitor."
    },
    "location_data": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "default": "location_data",
          "example": "location_data",
          "description": ""
        },
        "timezone": {
          "type": "string",
          "example": "Europe/Dublin",
          "description": "The timezone of the visitor."
        },
        "city_name": {
          "type": "string",
          "example": "Dublin",
          "description": "The city name of the visitor."
        },
        "postal_code": {
          "type": "string",
          "example": "D02 N960",
          "description": "The postal code of the visitor."
        },
        "region_name": {
          "type": "string",
          "example": "Leinster",
          "description": "The region name of the visitor."
        },
        "country_code": {
          "type": "string",
          "example": "IRL",
          "description": "The country code of the visitor."
        },
        "country_name": {
          "type": "string",
          "example": "Ireland",
          "description": "The country name of the visitor."
        },
        "continent_code": {
          "type": "string",
          "example": "EU",
          "description": "The continent code of the visitor."
        }
      }
    },
    "session_count": {
      "type": "integer",
      "example": 1,
      "description": "The number of sessions the Visitor has had."
    },
    "las_request_at": {
      "type": "integer",
      "example": 1663597260,
      "description": "The time the Lead last recorded making a request."
    },
    "social_profiles": {
      "type": "object",
      "properties": {
        "type": {
          "enum": [
            "social_profile.list"
          ],
          "type": "string",
          "example": "social_profile.list",
          "description": "The type of the object"
        },
        "social_profiles": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "has_hard_bounced": {
      "type": "boolean",
      "example": false,
      "description": "Identifies if this visitor has had a hard bounce."
    },
    "custom_attributes": {
      "type": "object",
      "description": "The custom attributes you have set on the Visitor.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "remote_created_at": {
      "type": "integer",
      "example": 1663597223,
      "description": "The time the Visitor was added to Intercom."
    },
    "marked_email_as_spam": {
      "type": "boolean",
      "example": false,
      "description": "Identifies if this visitor has marked an email as spam."
    },
    "unsubscribed_from_emails": {
      "type": "boolean",
      "example": false,
      "description": "Whether the Visitor is unsubscribed from emails."
    }
  },
  "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete."
}
object visitor_deleted_object
{
  "type": "object",
  "title": "Visitor Deleted Object",
  "properties": {
    "id": {
      "type": "string",
      "example": "530370b477ad7120001d",
      "description": "The unique identifier for the visitor which is given by Intercom."
    },
    "type": {
      "enum": [
        "visitor"
      ],
      "type": "string",
      "example": "visitor",
      "description": "The type of object which was deleted"
    },
    "user_id": {
      "type": "string",
      "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c",
      "description": "Automatically generated identifier for the Visitor."
    }
  },
  "description": "Response returned when an object is deleted"
}