Fin Agent User | Intercom and Fin Developer Platform

REST API Reference

Fin Agent User

A user object representing the user in a Fin Agent conversation.

idstringrequired

The ID of the user. This value will be used to uniquely identify the user during a conversation with Fin. Maps to the user_id field on the Intercom User object.

Example:"123456"

namestring

The name of the user.

Example:"John Doe"

emailstring, (email)

The email of the user.

Example:"john.doe@example.com"

attributesobject

A hash of attributes associated with the user. Attributes can be used by Fin to target content and responses. Limit to 10 attributes.

Example:

{
  "plan_type": "Pro",
  "subscription_status": "active"
}

{
  "id": "123456",
  "name": "John Doe",
  "email": "john.doe@example.com",
  "attributes": {
    "plan_type": "Pro",
    "subscription_status": "active"
  }
}