Create Ticket Reply Request Payload

URL https://developers.intercom.com

License MIT

Activity Log

Activities performed by Admins.

idstringrequired

The id representing the activity.

Example: "6"

performed_byobjectrequired

Details about the Admin involved in the activity.

performed_by.typestring

String representing the object's type. Always has the value admin.

Value"admin"

Example: "admin"

performed_by.idstring

The id representing the admin.

Example: "1295"

performed_by.emailstring

The email of the admin.

Example: "john@example.com"

performed_by.ipstring

The IP address of the admin.

Example: "198.51.100.255"

metadataobject(Activity Log Metadata)

Additional data provided about Admin activity.

created_atinteger(date-time)

The time the activity was created.

Example: 1671028894

activity_typestringrequired

Enum"admin_assignment_limit_change""admin_away_mode_change""admin_deletion""admin_deprovisioned""admin_impersonation_end""admin_impersonation_start""admin_invite_change""admin_invite_creation""admin_invite_deletion""admin_login_failure"

Example: "app_name_change"

activity_descriptionstring

A sentence or two describing the activity.

Example: "Admin updated the app's name to \"My App\"."

{
  "id": "6",
  "performed_by": {
    "type": "admin",
    "id": "1295",
    "email": "john@example.com",
    "ip": "198.51.100.255"
  },
  "metadata": {
    "sign_in_method": "email_password",
    "external_id": "f3b87a2e09d514c6c2e79b9a",
    "away_mode": true,
    "away_status_reason": "😌 On a break",
    "reassign_conversations": false,
    "source": "admin update from web - Admin id: 93",
    "auto_changed": false,
    "update_by": 93,
    "update_by_name": "Joe Bloggs"
  },
  "created_at": 1671028894,
  "activity_type": "app_name_change",
  "activity_description": "Admin updated the app's name to \"My App\"."
}

Paginated Response

A paginated list of activity logs.

typestringrequired

String representing the object's type. Always has the value activity_log.list.

Value"activity_log.list"

Example: "activity_log.list"

pagesobject(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

activity_logsArray of objects(Activity Log)required

An array of activity logs

activity_logs[].idstringrequired

The id representing the activity.

Example: "6"

activity_logs[].performed_byobjectrequired

Details about the Admin involved in the activity.

activity_logs[].performed_by.typestring

String representing the object's type. Always has the value admin.

Value"admin"

Example: "admin"

activity_logs[].performed_by.idstring

The id representing the admin.

Example: "1295"

activity_logs[].performed_by.emailstring

The email of the admin.

Example: "john@example.com"

activity_logs[].performed_by.ipstring

The IP address of the admin.

Example: "198.51.100.255"

activity_logs[].metadataobject(Activity Log Metadata)

Additional data provided about Admin activity.

activity_logs[].created_atinteger(date-time)

The time the activity was created.

Example: 1671028894

activity_logs[].activity_typestringrequired

Example: "app_name_change"

activity_logs[].activity_descriptionstring

A sentence or two describing the activity.

Example: "Admin updated the app's name to \"My App\"."

{
  "type": "activity_log.list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  },
  "activity_logs": [
    { … }
  ]
}

Activity Log Metadata

Additional data provided about Admin activity.

sign_in_methodstring or null

The way the admin signed in.

Example: "email_password"

external_idstring or null

The unique identifier for the contact which is provided by the Client.

Example: "f3b87a2e09d514c6c2e79b9a"

away_modeboolean or null

The away mode status which is set to true when away and false when returned.

Example: true

away_status_reasonstring or null

The reason the Admin is away.

Example: "😌 On a break"

reassign_conversationsboolean or null

Indicates if conversations should be reassigned while an Admin is away.

Example: false

sourcestring or null

The action that initiated the status change.

Example: "admin update from web - Admin id: 93"

auto_changedstring or null

Indicates if the status was changed automatically or manually.

Example: false

update_byinteger or null

The ID of the Admin who initiated the activity.

Example: 93

update_by_namestring or null

The name of the Admin who initiated the activity.

Example: "Joe Bloggs"

{
  "sign_in_method": "email_password",
  "external_id": "f3b87a2e09d514c6c2e79b9a",
  "away_mode": true,
  "away_status_reason": "😌 On a break",
  "reassign_conversations": false,
  "source": "admin update from web - Admin id: 93",
  "auto_changed": false,
  "update_by": 93,
  "update_by_name": "Joe Bloggs"
}

Addressable List

A list used to access other resources from a parent model.

typestring(uri)required

The addressable object type

Example: "note"

idstringrequired

The id of the addressable object

Example: "123"

urlstring(uri)required

Url to get more company resources for this contact

Example: "/contacts/5ba682d23d7cf92bef87bfd4/notes"

{
  "type": "note",
  "id": "123",
  "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes"
}

Admins

A list of admins associated with a given workspace.

typestringrequired

String representing the object's type. Always has the value admin.list.

Value"admin.list"

Example: "admin.list"

adminsArray of objects(Admin)required

A list of admins associated with a given workspace.

admins[].typestring

String representing the object's type. Always has the value admin.

Value"admin"

Example: "admin"

admins[].idstringrequired

The id representing the admin.

Example: "1295"

admins[].namestringrequired

The name of the admin.

Example: "Hoban Washburne"

admins[].emailstringrequired

The email of the admin.

Example: "wash@serenity.io"

admins[].job_titlestringrequired

The job title of the admin.

Example: "Philosopher"

admins[].away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example: false

admins[].away_mode_reassignbooleanrequired

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example: false

admins[].has_inbox_seatbooleanrequired

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example: true

admins[].team_idsArray of integersrequired

This object represents the avatar associated with the admin.

Example: [814865]

admins[].avatarstring or null(uri)

Image for the associated team or teammate

Example: "https://picsum.photos/200/300"

admins[].team_priority_levelobject(Team Priority Level)

Admin priority levels for teams

{
  "type": "admin.list",
  "admins": [
    { … }
  ]
}

Admin Priority Level

Admin priority levels for the team

primary_admin_idsArray of integers or null

The primary admin ids for the team

Example: [493881]

secondary_admin_idsArray of integers or null

The secondary admin ids for the team

Example: [814865]

{
  "primary_admin_ids": [
    493881
  ],
  "secondary_admin_ids": [
    814865
  ]
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Activity Log

Paginated Response

Activity Log Metadata

Addressable List

Admins

Admin Priority Level

Admin Reply