Intercom API (unofficial showcase)
POST/fin/capabilities

List Fin capabilities for a user

Lists the Fin capabilities available for a supplied user so an orchestrating agent can choose which action to call. Include the user's ID; if that user does not exist, Fin creates a user from the supplied details, and updates the email and attributes of an existing user.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The user to retrieve capabilities for. The user object and its id are required.

userobjectrequired
The user whose available Fin capabilities to list. If the user ID is new, Fin creates a user; if it already exists, the supplied email and attributes update it.

3 status codes
200Returns the API version used to generate the capabilities document and an array of capabilities available to the supplied user.
versionstringoptional
The API version the capabilities document was generated for.
capabilitiesarray<object>optional
The list of capabilities available to this user.
400Returned when the request is invalid, including when the required user details are missing or fail validation.

One documented failure

  • parameter_invalid

    Cannot update more than 10 attributes at once.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the request is invalid; include the required user object and its required id. A 401 is returned when the request is unauthorized. Supply a valid email address in user.email if you include that field.