Skip to content

Add channel field to ticket creation endpoints (from v2.14) - #320

Merged
VarshSuresh merged 3 commits into
mainfrom
VarshSuresh/add-ticket-channel-to-open-api
Oct 12, 2026
Merged

VarshSuresh merged 3 commits into
mainfrom
VarshSuresh/add-ticket-channel-to-open-api

Conversation

@VarshSuresh

@VarshSuresh VarshSuresh commented Oct 16, 2025 •

Copy link
Copy Markdown
Contributor

Why?

Towards https://github.com/intercom/intercom/issues/429620

Summary

This PR adds a new channel field to ticket creation and conversion endpoints in the unstable API specification.

Changes

  • Added channel field to create_ticket_request schema
  • Added channel field to ticket response schema

Field Details

  • Type: string (enum)
  • Supported values: "email" (currently the only supported value in request schemas)
  • Scope: Only supported for customer ticket types
  • Default behavior: Defaults to "messenger" when not provided

Modified Schemas

  1. create_ticket_request (descriptions/0/api.intercom.io.yaml:18989-18994)
  2. ticket (descriptions/0/api.intercom.io.yaml:22022-22028)

🤖 Generated with Claude Code


Update (rebased 2026-10-12)

Rebased onto latest main. Expanded from descriptions/0 (Preview) only to document channel across 2.14, 2.15, 2.16, and 0 — the field is gated to API v2.14+ in the monolith (AllowChannelToTicket).

Shapes match the code: request channel enum [email] (SUPPORTED_CHANNELS = %w[email]); response channel enum [email, messenger], default messenger (reflects the conversation initial channel). The transient add/remove of channel on convert_conversation_to_ticket_request nets to no change. Companion monolith PR: intercom/intercom#438901; docs PR: intercom/developer-docs#633.

@VarshSuresh VarshSuresh changed the title Add channel field to ticket creation endpoints Add channel field to ticket creation endpoints in Unstable Oct 16, 2025
@VarshSuresh
VarshSuresh requested a review from a team October 16, 2025 22:41
Eclairemoy
Eclairemoy previously approved these changes Nov 3, 2025
adisan19
adisan19 previously approved these changes Oct 12, 2026
Document the optional `channel` field on the Create Ticket endpoint,
available from API version 2.14 (AllowChannelToTicket). Request accepts
`email` only (SUPPORTED_CHANNELS); the ticket response channel reflects
the conversation's initial channel. Added to the create ticket request
and ticket response schemas and the request examples across 2.14, 2.15,
2.16 and 0 (Preview).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@VarshSuresh
VarshSuresh dismissed stale reviews from adisan19 and Eclairemoy via 68561ca October 12, 2026 11:40
@VarshSuresh
VarshSuresh force-pushed the VarshSuresh/add-ticket-channel-to-open-api branch from f1d7338 to 68561ca Compare October 12, 2026 11:40
@VarshSuresh VarshSuresh changed the title Add channel field to ticket creation endpoints in Unstable Add channel field to ticket creation endpoints (from v2.14) Oct 12, 2026
VarshSuresh and others added 2 commits October 12, 2026 13:03
- Ticket response: the channel field returns the channel the ticket was created
  through (any channel, or null) and defaults to messenger, so drop the
  restrictive enum and make it nullable.
- Create-ticket and enqueue request examples: pair channel: email with a
  customer ticket type (ticket_type_id 1) instead of the Back-office example
  type, since channel is only supported for customer tickets.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Revert the example ticket_type_id to its original illustrative value, keeping
channel: email in the create-ticket request examples.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@VarshSuresh
VarshSuresh requested a review from adisan19 October 12, 2026 12:24
@VarshSuresh
VarshSuresh merged commit d769903 into main Oct 12, 2026
4 checks passed
@VarshSuresh
VarshSuresh deleted the VarshSuresh/add-ticket-channel-to-open-api branch October 12, 2026 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants