Skip to content

Align the 2.13 API reference across repositories - #722

Merged
markdennis22 merged 3 commits into
mainfrom
align/2.13
Oct 15, 2026
Merged

markdennis22 merged 3 commits into
mainfrom
align/2.13

Conversation

@markdennis22

Copy link
Copy Markdown
Contributor

Why?

The 2.13 reference on developers.intercom.com and this spec had drifted apart, so they described two different 2.13 APIs. This PR fixes the items where this spec was wrong or behind; a companion PR updates the other side.

How?

Names the two custom object instance delete operations after the identifier each one takes, describes list and other data attribute types the way 2.14 does, writes "Unix timestamp" the same way everywhere and swaps twitter.com example URLs for example.com. It also says that the activity log previous_state and new_state fields carry enabled or disabled for IP allowlist changes, adds the two occupancy event types to the activity log response example, and gives the before and after values in changes an example each, saying they take the setting's own type. Affects 2.13 only.

Notes for reviewers

Fern check: 0 errors and the same 313 warnings as main. Fern reads only 2.14 and Preview, so it doesn't cover the 2.13 file.

Generated with Claude Code

markdennis22 and others added 3 commits October 14, 2026 14:30
- Name the two DELETE /custom_object_instances operations after the
  identifier each takes: deleteCustomObjectInstancesById for the path
  with {id}, deleteCustomObjectInstancesByExternalId for the one that
  takes external_id.
- Describe list and other data attribute types with oneOf in
  create_data_attribute_request and update_data_attribute_request, as
  2.14 does. List options are objects with a value key.
- Write "Unix timestamp", and "Unix timestamp in seconds" in the search
  operator tables.
- Use example.com instead of twitter.com in the POST /messages and
  social_profile examples.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The activity log metadata fields previous_state and new_state also carry
`enabled` or `disabled` for IP allowlist changes, not only `idle` or
`occupied` for occupancy changes.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Add an admin_occupancy_state_change and an admin_occupancy_setting_change
entry to the GET /admins/activity_logs response example, so it shows
previous_state, new_state, threshold_minutes, last_activity_at, auto,
setting_type and changes. The state change is recorded by the system,
so its performed_by ip is `unknown`.

The before and after values in activity_log_metadata.changes get an
example each, and their descriptions say they take the setting's own
type. They keep no `type`, because the value can be an integer, a
boolean, a string or a list depending on the setting.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@markdennis22
markdennis22 marked this pull request as ready for review October 14, 2026 14:25
@markdennis22
markdennis22 merged commit 10fa704 into main Oct 15, 2026
4 checks passed
@markdennis22
markdennis22 deleted the align/2.13 branch October 15, 2026 08:57
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.

2 participants