Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.intercom.com/docs/references/unstable/rest-api/api.intercom.io/data-attributes below:

Data Attributes

The intercom API reference.

https://api.eu.intercom.io/

https://api.au.intercom.io/

Everything about your Admins

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Everything about your Articles

Everything about your Away Status Reasons

Everything about your Companies

Everything about your Conversations

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Everything about your Data Attributes

Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.

Value is data_attribute.

Value"data_attribute"

Example: "data_attribute"

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

Example: 12878

Value is contact for user/lead attributes and company for company attributes.

Enum"contact""company"

Example: "contact"

Example: "paid_subscriber"

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

Example: "custom_attributes.paid_subscriber"

Readable name of the attribute (i.e. name you see in the UI)

Example: "Paid Subscriber"

Readable description of the attribute.

Example: "Whether the user is a paid subscriber."

The data type of the attribute.

Enum"string""integer""float""boolean""date"

Example: "boolean"

List of predefined options for attribute value.

Example: ["true","false"]

Can this attribute be updated through API

Example: true

Can this attribute be updated by the Messenger

Example: false

Can this attribute be updated in the UI

Example: true

Set to true if this is a CDA

Example: true

Is this attribute archived. (Only applicable to CDAs)

Example: false

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

Teammate who created the attribute. Only applicable to CDAs

Example: "5712945"

{
  "type": "data_attribute",
  "id": 12878,
  "model": "contact",
  "name": "paid_subscriber",
  "full_name": "custom_attributes.paid_subscriber",
  "label": "Paid Subscriber",
  "description": "Whether the user is a paid subscriber.",
  "data_type": "boolean",
  "options": [
    "true",
    "false"
  ],
  "api_writable": true,
  "messenger_writable": false,
  "ui_writable": true,
  "custom": true,
  "archived": false,
  "created_at": 1671028894,
  "updated_at": 1671028894,
  "admin_id": "5712945"
}

You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.

Specify the data attribute model to return.

Enum"contact""company""conversation"

Example: model=company

Include archived attributes in the list. By default we return only non archived data attributes.

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: Unstable

curl -i -X GET \
  'https://api.intercom.io/data_attributes?model=company&include_archived=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Unstable'

Value"list"

Example: "list"

A list of data attributes

{
  "type": "list",
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

You can create a data attributes for a contact or a company.

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: Unstable

The name of the data attribute.

Example: "My Data Attribute"

The model that the data attribute belongs to.

Enum"contact""company"

Example: "contact"

The type of data stored for this attribute.

Enum"string""integer""float""boolean""datetime""date"

Example: "string"

The readable description you see in the UI for the attribute.

Example: "My Data Attribute 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.

Example: ["option1","option2"]

Can this attribute be updated by the Messenger

Example: false

curl -i -X POST \
  https://api.intercom.io/data_attributes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Unstable' \
  -d '{
    "name": "Mithril Shirt",
    "model": "company",
    "data_type": "string"
  }'

Value is data_attribute.

Value"data_attribute"

Example: "data_attribute"

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

Example: 12878

Value is contact for user/lead attributes and company for company attributes.

Enum"contact""company"

Example: "contact"

Example: "paid_subscriber"

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

Example: "custom_attributes.paid_subscriber"

Readable name of the attribute (i.e. name you see in the UI)

Example: "Paid Subscriber"

Readable description of the attribute.

Example: "Whether the user is a paid subscriber."

The data type of the attribute.

Enum"string""integer""float""boolean""date"

Example: "boolean"

List of predefined options for attribute value.

Example: ["true","false"]

Can this attribute be updated through API

Example: true

Can this attribute be updated by the Messenger

Example: false

Can this attribute be updated in the UI

Example: true

Set to true if this is a CDA

Example: true

Is this attribute archived. (Only applicable to CDAs)

Example: false

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

Teammate who created the attribute. Only applicable to CDAs

Example: "5712945"

{
  "id": 37,
  "type": "data_attribute",
  "name": "Mithril Shirt",
  "full_name": "custom_attributes.Mithril Shirt",
  "label": "Mithril Shirt",
  "data_type": "string",
  "api_writable": true,
  "ui_writable": false,
  "messenger_writable": false,
  "custom": true,
  "archived": false,
  "admin_id": "991267786",
  "created_at": 1734537756,
  "updated_at": 1734537756,
  "model": "company"
}

You can update a data attribute.

🚧 Updating the data type is not possible

It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.

Intercom API version.
By default, it's equal to the version set in the app package.

Default Unstable

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: Unstable

Whether the attribute is to be archived or not.

Example: false

The readable description you see in the UI for the attribute.

Example: "My Data Attribute 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.

Example: ["option1","option2"]

Can this attribute be updated by the Messenger

Example: false

curl -i -X PUT \
  https://api.intercom.io/data_attributes/1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Unstable' \
  -d '{
    "description": "Just a plain old ring",
    "options": [
      {
        "value": "1-10"
      },
      {
        "value": "11-20"
      }
    ],
    "archived": false
  }'

Value is data_attribute.

Value"data_attribute"

Example: "data_attribute"

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

Example: 12878

Value is contact for user/lead attributes and company for company attributes.

Enum"contact""company"

Example: "contact"

Example: "paid_subscriber"

Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

Example: "custom_attributes.paid_subscriber"

Readable name of the attribute (i.e. name you see in the UI)

Example: "Paid Subscriber"

Readable description of the attribute.

Example: "Whether the user is a paid subscriber."

The data type of the attribute.

Enum"string""integer""float""boolean""date"

Example: "boolean"

List of predefined options for attribute value.

Example: ["true","false"]

Can this attribute be updated through API

Example: true

Can this attribute be updated by the Messenger

Example: false

Can this attribute be updated in the UI

Example: true

Set to true if this is a CDA

Example: true

Is this attribute archived. (Only applicable to CDAs)

Example: false

The time the attribute was created as a UTC Unix timestamp

Example: 1671028894

The time the attribute was last updated as a UTC Unix timestamp

Example: 1671028894

Teammate who created the attribute. Only applicable to CDAs

Example: "5712945"

{
  "id": 44,
  "type": "data_attribute",
  "name": "The One Ring",
  "full_name": "custom_attributes.The One Ring",
  "label": "The One Ring",
  "description": "Just a plain old ring",
  "data_type": "string",
  "options": [
    "1-10",
    "11-20"
  ],
  "api_writable": true,
  "ui_writable": false,
  "messenger_writable": true,
  "custom": true,
  "archived": false,
  "admin_id": "991267793",
  "created_at": 1734537762,
  "updated_at": 1734537763,
  "model": "company"
}

Everything about your Data Events

Everything about your Data Exports

Everything about your Help Center

Everything about your Internal Articles

Operations related to saved replies (macros) in conversations

Everything about your messages

Everything about your News

Everything about your Notes

Everything about Reporting Data Export

Everything about your Segments

Everything about subscription types

Everything about your Teams

Everything about your ticket states

Everything about your ticket type attributes

Everything about your ticket types

Everything about your tickets

Everything about your Visitors

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4