RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.intercom.com/docs/references/rest-api/api.intercom.io/admins/setawayadmin below:

Set an admin to away

Intercom API (2.14)

The intercom API reference.

Download OpenAPI description

The production API server The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Admin

Admins are teammate accounts that have access to a workspace.

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

Example: "admin"

The id representing the admin.

Example: "1295"

Example: "jdoe@example.com"

The job title of the admin.

Example: "Associate"

Identifies if this admin is currently set in away mode.

Example: false

away_mode_reassignboolean

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

Example: false

away_status_reason_idinteger or null

The unique identifier of the away status reason

Example: 12345

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

Example: true

team_idsArray of integers

This object represents the avatar associated with the admin.

Example: [814865]

avatarstring or null(uri)

Image for the associated team or teammate

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

team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

{ "type": "admin", "id": "1295", "name": "Joe Example", "email": "jdoe@example.com", "job_title": "Associate", "away_mode_enabled": false, "away_mode_reassign": false, "away_status_reason_id": 12345, "has_inbox_seat": true, "team_ids": [ 814865 ], "avatar": "https://picsum.photos/200/300", "team_priority_level": { "primary_team_ids": [ … ], "secondary_team_ids": [ … ] } }

Request

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

🚧 Single Sign On

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The production API server https://api.intercom.io/me
The european API server https://api.eu.intercom.io/me
The australian API server https://api.au.intercom.io/me

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X GET \
  https://api.intercom.io/me \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Bodyapplication/json

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

Example: "admin"

The id representing the admin.

Example: "1295"

Example: "jdoe@example.com"

The job title of the admin.

Example: "Associate"

Identifies if this admin is currently set in away mode.

Example: false

away_mode_reassignboolean

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

Example: false

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

Example: true

team_idsArray of integers

This is a list of ids of the teams that this admin is part of.

Example: [814865]

This object represents the avatar associated with the admin.

email_verifiedboolean or null

Identifies if this admin's email is verified.

Example: true

App is a workspace on Intercom

{ "type": "admin", "id": "991267459", "email": "admin1@email.com", "name": "Ciaran1 Lee", "email_verified": true, "app": { "type": "app", "id_code": "this_is_an_id1_that_should_be_at_least_40", "name": "MyApp 1", "created_at": 1734537243, "secure": false, "identity_verification": false, "timezone": "America/Los_Angeles", "region": "US" }, "avatar": { "type": "avatar", "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png" }, "has_inbox_seat": true }

Request

You can set an Admin as away for the Inbox.

Path

The unique identifier of a given admin

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

Bodyapplication/json away_mode_enabledbooleanrequired

Set to "true" to change the status of the admin to away.

Default true

Example: true

away_mode_reassignbooleanrequired

Set to "true" to assign any new conversation replies to your default inbox.

Default false

Example: false

away_status_reason_idinteger

The unique identifier of the away status reason

Example: 12345

The production API server https://api.intercom.io/admins/{id}/away
The european API server https://api.eu.intercom.io/admins/{id}/away
The australian API server https://api.au.intercom.io/admins/{id}/away

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X PUT \
  'https://api.intercom.io/admins/{id}/away' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.14' \
  -d '{
    "away_mode_enabled": true,
    "away_mode_reassign": true,
    "away_status_reason_id": 12345
  }'

Bodyapplication/json

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

Example: "admin"

The id representing the admin.

Example: "1295"

Example: "jdoe@example.com"

The job title of the admin.

Example: "Associate"

Identifies if this admin is currently set in away mode.

Example: false

away_mode_reassignboolean

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

Example: false

away_status_reason_idinteger or null

The unique identifier of the away status reason

Example: 12345

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

Example: true

team_idsArray of integers

This object represents the avatar associated with the admin.

Example: [814865]

avatarstring or null(uri)

Image for the associated team or teammate

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

team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

{ "type": "admin", "id": "991267460", "name": "Ciaran2 Lee", "email": "admin2@email.com", "away_mode_enabled": true, "away_mode_reassign": true, "has_inbox_seat": true, "away_status_reason_id": "12345", "team_ids": [] }

Request

You can get a log of activities by all admins in an app.

Query created_at_afterstringrequired

The start date that you request data for. It must be formatted as a UNIX timestamp.

Example: created_at_after=1677253093

The end date that you request data for. It must be formatted as a UNIX timestamp.

Example: created_at_before=1677861493

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The production API server https://api.intercom.io/admins/activity_logs
The european API server https://api.eu.intercom.io/admins/activity_logs
The australian API server https://api.au.intercom.io/admins/activity_logs

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X GET \
  'https://api.intercom.io/admins/activity_logs?created_at_after=1677253093&created_at_before=1677861493' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Bodyapplication/json

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

Example: "activity_log.list"

pagesobject or null(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 or null(Activity Log)

An array of activity logs

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

Request

You can fetch a list of admins for a given workspace.

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The production API server https://api.intercom.io/admins
The european API server https://api.eu.intercom.io/admins
The australian API server https://api.au.intercom.io/admins

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X GET \
  https://api.intercom.io/admins \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Bodyapplication/json

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

Example: "admin.list"

adminsArray of objects or null(Admin)

A list of admins associated with a given workspace.

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

Request

You can retrieve the details of a single admin.

Path

The unique identifier of a given admin

Example: 123

Headers Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.14

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.14

The production API server https://api.intercom.io/admins/{id}
The european API server https://api.eu.intercom.io/admins/{id}
The australian API server https://api.au.intercom.io/admins/{id}

curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R

curl -i -X GET \
  https://api.intercom.io/admins/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.14'

Bodyapplication/json

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

Example: "admin"

The id representing the admin.

Example: "1295"

Example: "jdoe@example.com"

The job title of the admin.

Example: "Associate"

Identifies if this admin is currently set in away mode.

Example: false

away_mode_reassignboolean

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

Example: false

away_status_reason_idinteger or null

The unique identifier of the away status reason

Example: 12345

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

Example: true

team_idsArray of integers

This object represents the avatar associated with the admin.

Example: [814865]

avatarstring or null(uri)

Image for the associated team or teammate

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

team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

{ "type": "admin", "id": "991267468", "name": "Ciaran9 Lee", "email": "admin9@email.com", "away_mode_enabled": false, "away_mode_reassign": false, "has_inbox_seat": true, "away_status_reason_id": null, "team_ids": [] }

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Articles

Everything about your Articles

Away Status Reasons

Everything about your Away Status Reasons

Companies

Everything about your Companies

Conversations

Everything about your Conversations

Custom Channel Events

With the "Custom Channel" integration, you can bring Fin and Intercom capabilities to your own platform via API, enabling powerful custom integrations.

Intercom treats your integration like any other Intercom channel, allowing your application and Intercom to exchange events seamlessly. This makes it possible, for example, for your users to interact with Fin directly within your own application’s UI.

Note: "Fin over API" is currently under managed availability. Please reach out to your accounts team to discuss access and tailored, hands-on support.

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

Data Attributes

Everything about your Data Attributes

Data Events

Everything about your Data Events

Data Export

Everything about your Data Exports

Help Center

Everything about your Help Center

Internal Articles

Everything about your Internal Articles

Messages

Everything about your messages

News

Everything about your News

Notes

Everything about your Notes

Reporting Data Export

Everything about Reporting Data Export

Segments

Everything about your Segments

Subscription Types

Everything about subscription types

Teams

Everything about your Teams

Ticket States

Everything about your ticket states

Ticket Type Attributes

Everything about your ticket type attributes

Ticket Types

Everything about your ticket types

Tickets

Everything about your tickets

Visitors

Everything about your Visitors

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4