Skip to content

Conversation

idstringrequired

Unique identifier for the conversation in your system

Example:"conv_456"
statusstring(ConversationStatus)required

Current conversation status:

  • open - Conversation is actively ongoing with the end-user
  • resolved - Conversation is resolved by Fin
  • closed - Conversation is finished/archived
  • ended - Conversation is ended by the end-user or agent
Enum:"open""resolved""closed""ended"
Example:"resolved"
userobject(EndUser)required

End user having a conversation with Fin or with an agent.

titlestring or null

Conversation title or subject

Example:"Question about pricing plans"
tagsArray of strings or null

List of tags associated with the conversation in your system. Can be used to power routing within the Fin workflow among other things.

Example:
[ "pricing", "sales" ]
attributesobject(ConversationAttributes)

Attributes associated with the conversation

Example:
{ "issue_type": "Billing", "priority": "High" }
assigneeobject or null(Agent)

Agent having a conversation with an end-user.

created_atstring, (date-time)required

When the conversation was created (ISO 8601 UTC)

Example:"2025-10-27T14:30:00.000Z"
updated_atstring, (date-time)required

When the conversation was last updated (ISO 8601 UTC)

Example:"2025-10-27T15:45:00.000Z"
{ "id": "conv_456", "status": "resolved", "user": { "id": "user_123456", "user_type": "end_user", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "attributes": { … } }, "title": "Question about pricing plans", "tags": [ "pricing", "sales" ], "attributes": { "issue_type": "Billing", "priority": "High" }, "assignee": { "id": "agent_123456", "user_type": "agent", "name": "Jane Doe", "email": "jane.doe@example.com", "photo_url": "https://example.com/avatars/jane.jpg", "alias_name": "Support Jane" }, "created_at": "2025-10-27T14:30:00.000Z", "updated_at": "2025-10-27T15:45:00.000Z" }