Skip to content

Fix conversation model assignee ID types to match API responses#453

Open
VarshSuresh wants to merge 1 commit intomainfrom
VarshSuresh/update-conversation-docs
Open

Fix conversation model assignee ID types to match API responses#453
VarshSuresh wants to merge 1 commit intomainfrom
VarshSuresh/update-conversation-docs

Conversation

@VarshSuresh
Copy link
Copy Markdown
Contributor

@VarshSuresh VarshSuresh commented Apr 15, 2026

Why?

Towards Dev Rel PQ

The conversations API (GET /:id, GET /all, POST /search) returns admin_assignee_id and team_assignee_id as integers, returning 0 when unassigned. However, the docs had team_assignee_id typed as string, both fields marked as nullable, descriptions referencing null, and search tables listing both as String. The tickets API correctly returns these as strings and its docs are accurate, this PR consolidates the conversation model to match the actual API behavior.

How?

  • Updated team_assignee_id to integer type
  • Removed nullable: true
  • Changed descriptions from "return null" to "return 0"
  • fixed search table types from String to Integer, and
  • added alternating integer/zero example values in response examples — all scoped to the conversation model across every version (@2.7 through @Preview). Ticket model is intentionally unchanged.
Implementation Plan

Plan: Fix admin_assignee_id and team_assignee_id types in conversation model

Context

The real Intercom API returns admin_assignee_id and team_assignee_id as integers in conversation responses. The docs have these typed incorrectly as strings in several places. Scope: Conversations model only — ticket model stays unchanged.


@2.7–@Preview (OpenAPI YAML files)

Schema type fix: team_assignee_id in conversation schemas

Each version has TWO conversation schemas (conversation_list_item and conversation). Change in both:

  • type: stringtype: integer
  • example: '5017691'example: 5017691

Search conversation doc tables (inline in YAML)

Change both admin_assignee_id and team_assignee_id from String to Integer in the conversation search table only (NOT the ticket search table).

Response examples updated with alternating integer/zero values


What NOT to change

  • Ticket schemasadmin_assignee_id and team_assignee_id are correctly string in tickets
  • Ticket search tables — leave as String
  • Ticket response examples — quoted string values like '0' are correct

Mirrors intercom/developer-docs#842.

Generated with Claude Code

Updated team_assignee_id to integer type, removed nullable: true,
changed descriptions from "return null" to "return 0", fixed search
table types from String to Integer, and added alternating integer/zero
example values in response examples — all scoped to the conversation
model across every version (2.7 through Preview). Ticket model is
intentionally unchanged.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@VarshSuresh VarshSuresh self-assigned this Apr 15, 2026
@VarshSuresh VarshSuresh requested a review from a team April 15, 2026 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant