Intercom

intercom

Intercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale

Customer Support CRM Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Sí

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (51)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add subscription to a contactINTERCOM_ADD_SUBSCRIPTION_TO_A_CONTACTAcción

You can add a specific subscription to a contact. in intercom, we have two different subscription types based on user consent - opt-out and opt-in: 1.attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. 2.attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. this will return a subscription type model for the subscription type that was added to the contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the subscription which is given by Intercom
contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom
consent_typestringObligatorio
The consent_type of a subscription, opt_out or opt_in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add tag to a contactINTERCOM_ADD_TAG_TO_A_CONTACTAcción

You can tag a specific contact. this will return a tag object for the tag that was added to the contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the tag which is given by Intercom
contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign conversationINTERCOM_ASSIGN_CONVERSATIONAcción

Assigns a conversation to a specific admin or team in intercom

Parámetros de entrada

team_idstring
ID of the team to assign the conversation to. Either admin_id or team_id must be provided
admin_idstring
ID of the admin to assign the conversation to. Either admin_id or team_id must be provided
assignee_idstring
ID of the admin making the assignment (who is performing this action)
conversation_idstringObligatorio
The ID of the conversation to assign

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Attach a contact to a companyINTERCOM_ATTACH_A_CONTACT_TO_A_COMPANYAcción

You can attach a company to a single contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Close conversationINTERCOM_CLOSE_CONVERSATIONAcción

Closes a conversation in intercom, marking it as resolved

Parámetros de entrada

bodystring
Optional message to send when closing the conversation
admin_idstringObligatorio
ID of the admin closing the conversation
conversation_idstringObligatorio
The ID of the conversation to close

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a collectionINTERCOM_CREATE_A_COLLECTIONAcción

You can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`

Parámetros de entrada

namestringObligatorio
The name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstring
The id of the parent collection. If `null` then it will be created as the first level collection.
descriptionstring
The description of the collection. For multilingual collections, this will be the description of the default language"s content.
help_center_idinteger
The id of the help center where the collection will be created. If `null` then it will be created in the default help center.
translated__content__typestringenum
The type of object - group_translated_content.
Nonegroup_translated_content
translated__content__ar__namestring
The name of the collection or section.
translated__content__ar__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__bg__namestring
The name of the collection or section.
translated__content__bg__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__bs__namestring
The name of the collection or section.
translated__content__bs__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ca__namestring
The name of the collection or section.
translated__content__ca__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__cs__namestring
The name of the collection or section.
translated__content__cs__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__da__namestring
The name of the collection or section.
translated__content__da__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__de__namestring
The name of the collection or section.
translated__content__de__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__el__namestring
The name of the collection or section.
translated__content__el__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__en__namestring
The name of the collection or section.
translated__content__en__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__es__namestring
The name of the collection or section.
translated__content__es__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__et__namestring
The name of the collection or section.
translated__content__et__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__fi__namestring
The name of the collection or section.
translated__content__fi__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__fr__namestring
The name of the collection or section.
translated__content__fr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__he__namestring
The name of the collection or section.
translated__content__he__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__hr__namestring
The name of the collection or section.
translated__content__hr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__hu__namestring
The name of the collection or section.
translated__content__hu__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__id__namestring
The name of the collection or section.
translated__content__id__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__it__namestring
The name of the collection or section.
translated__content__it__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ja__namestring
The name of the collection or section.
translated__content__ja__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ko__namestring
The name of the collection or section.
translated__content__ko__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__lt__namestring
The name of the collection or section.
translated__content__lt__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__lv__namestring
The name of the collection or section.
translated__content__lv__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__mn__namestring
The name of the collection or section.
translated__content__mn__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__nb__namestring
The name of the collection or section.
translated__content__nb__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__nl__namestring
The name of the collection or section.
translated__content__nl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pl__namestring
The name of the collection or section.
translated__content__pl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pt__namestring
The name of the collection or section.
translated__content__pt__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ro__namestring
The name of the collection or section.
translated__content__ro__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ru__namestring
The name of the collection or section.
translated__content__ru__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sl__namestring
The name of the collection or section.
translated__content__sl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sr__namestring
The name of the collection or section.
translated__content__sr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sv__namestring
The name of the collection or section.
translated__content__sv__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__tr__namestring
The name of the collection or section.
translated__content__tr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__vi__namestring
The name of the collection or section.
translated__content__vi__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pt__BR__namestring
The name of the collection or section.
translated__content__pt__BR__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__zh__CN__namestring
The name of the collection or section.
translated__content__zh__CN__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__zh__TW__namestring
The name of the collection or section.
translated__content__zh__TW__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ar__descriptionstring
The description of the collection. Only available for collections.
translated__content__bg__descriptionstring
The description of the collection. Only available for collections.
translated__content__bs__descriptionstring
The description of the collection. Only available for collections.
translated__content__ca__descriptionstring
The description of the collection. Only available for collections.
translated__content__cs__descriptionstring
The description of the collection. Only available for collections.
translated__content__da__descriptionstring
The description of the collection. Only available for collections.
translated__content__de__descriptionstring
The description of the collection. Only available for collections.
translated__content__el__descriptionstring
The description of the collection. Only available for collections.
translated__content__en__descriptionstring
The description of the collection. Only available for collections.
translated__content__es__descriptionstring
The description of the collection. Only available for collections.
translated__content__et__descriptionstring
The description of the collection. Only available for collections.
translated__content__fi__descriptionstring
The description of the collection. Only available for collections.
translated__content__fr__descriptionstring
The description of the collection. Only available for collections.
translated__content__he__descriptionstring
The description of the collection. Only available for collections.
translated__content__hr__descriptionstring
The description of the collection. Only available for collections.
translated__content__hu__descriptionstring
The description of the collection. Only available for collections.
translated__content__id__descriptionstring
The description of the collection. Only available for collections.
translated__content__it__descriptionstring
The description of the collection. Only available for collections.
translated__content__ja__descriptionstring
The description of the collection. Only available for collections.
translated__content__ko__descriptionstring
The description of the collection. Only available for collections.
translated__content__lt__descriptionstring
The description of the collection. Only available for collections.
translated__content__lv__descriptionstring
The description of the collection. Only available for collections.
translated__content__mn__descriptionstring
The description of the collection. Only available for collections.
translated__content__nb__descriptionstring
The description of the collection. Only available for collections.
translated__content__nl__descriptionstring
The description of the collection. Only available for collections.
translated__content__pl__descriptionstring
The description of the collection. Only available for collections.
translated__content__pt__descriptionstring
The description of the collection. Only available for collections.
translated__content__ro__descriptionstring
The description of the collection. Only available for collections.
translated__content__ru__descriptionstring
The description of the collection. Only available for collections.
translated__content__sl__descriptionstring
The description of the collection. Only available for collections.
translated__content__sr__descriptionstring
The description of the collection. Only available for collections.
translated__content__sv__descriptionstring
The description of the collection. Only available for collections.
translated__content__tr__descriptionstring
The description of the collection. Only available for collections.
translated__content__vi__descriptionstring
The description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstring
The description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstring
The description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstring
The description of the collection. Only available for collections.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create an articleINTERCOM_CREATE_AN_ARTICLEAcción

You can create a new article by making a post request to `https://api.intercom.io/articles`.

Parámetros de entrada

bodystring
The content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringenum
Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language"s content.
publisheddraft
titlestringObligatorio
The title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idintegerObligatorio
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language"s content. Must be a teammate on the help center"s workspace.
parent_idinteger
The id of the article"s parent collection or section. An article without this field stands alone.
descriptionstring
The description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestring
The type of parent, which can either be a `collection` or `section`.
translated__content__typestringenum
The type of object - article_translated_content.
Nonearticle_translated_content
translated__content__ar__urlstring
The URL of the article.
translated__content__bg__urlstring
The URL of the article.
translated__content__bs__urlstring
The URL of the article.
translated__content__ca__urlstring
The URL of the article.
translated__content__cs__urlstring
The URL of the article.
translated__content__da__urlstring
The URL of the article.
translated__content__de__urlstring
The URL of the article.
translated__content__el__urlstring
The URL of the article.
translated__content__en__urlstring
The URL of the article.
translated__content__es__urlstring
The URL of the article.
translated__content__et__urlstring
The URL of the article.
translated__content__fi__urlstring
The URL of the article.
translated__content__fr__urlstring
The URL of the article.
translated__content__he__urlstring
The URL of the article.
translated__content__hr__urlstring
The URL of the article.
translated__content__hu__urlstring
The URL of the article.
translated__content__id__urlstring
The URL of the article.
translated__content__it__urlstring
The URL of the article.
translated__content__ja__urlstring
The URL of the article.
translated__content__ko__urlstring
The URL of the article.
translated__content__lt__urlstring
The URL of the article.
translated__content__lv__urlstring
The URL of the article.
translated__content__mn__urlstring
The URL of the article.
translated__content__nb__urlstring
The URL of the article.
translated__content__nl__urlstring
The URL of the article.
translated__content__pl__urlstring
The URL of the article.
translated__content__pt__urlstring
The URL of the article.
translated__content__ro__urlstring
The URL of the article.
translated__content__ru__urlstring
The URL of the article.
translated__content__sl__urlstring
The URL of the article.
translated__content__sr__urlstring
The URL of the article.
translated__content__sv__urlstring
The URL of the article.
translated__content__tr__urlstring
The URL of the article.
translated__content__vi__urlstring
The URL of the article.
translated__content__ar__bodystring
The body of the article.
translated__content__ar__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__bg__bodystring
The body of the article.
translated__content__bg__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__bs__bodystring
The body of the article.
translated__content__bs__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ca__bodystring
The body of the article.
translated__content__ca__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__cs__bodystring
The body of the article.
translated__content__cs__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__da__bodystring
The body of the article.
translated__content__da__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__de__bodystring
The body of the article.
translated__content__de__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__el__bodystring
The body of the article.
translated__content__el__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__en__bodystring
The body of the article.
translated__content__en__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__es__bodystring
The body of the article.
translated__content__es__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__et__bodystring
The body of the article.
translated__content__et__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__fi__bodystring
The body of the article.
translated__content__fi__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__fr__bodystring
The body of the article.
translated__content__fr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__he__bodystring
The body of the article.
translated__content__he__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__hr__bodystring
The body of the article.
translated__content__hr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__hu__bodystring
The body of the article.
translated__content__hu__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__id__bodystring
The body of the article.
translated__content__id__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__it__bodystring
The body of the article.
translated__content__it__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ja__bodystring
The body of the article.
translated__content__ja__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ko__bodystring
The body of the article.
translated__content__ko__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__lt__bodystring
The body of the article.
translated__content__lt__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__lv__bodystring
The body of the article.
translated__content__lv__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__mn__bodystring
The body of the article.
translated__content__mn__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__nb__bodystring
The body of the article.
translated__content__nb__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__nl__bodystring
The body of the article.
translated__content__nl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pl__bodystring
The body of the article.
translated__content__pl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pt__bodystring
The body of the article.
translated__content__pt__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ro__bodystring
The body of the article.
translated__content__ro__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ru__bodystring
The body of the article.
translated__content__ru__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sl__bodystring
The body of the article.
translated__content__sl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sr__bodystring
The body of the article.
translated__content__sr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sv__bodystring
The body of the article.
translated__content__sv__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__tr__bodystring
The body of the article.
translated__content__tr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__vi__bodystring
The body of the article.
translated__content__vi__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ar__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ar__titlestring
The title of the article.
translated__content__bg__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__bg__titlestring
The title of the article.
translated__content__bs__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__bs__titlestring
The title of the article.
translated__content__ca__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ca__titlestring
The title of the article.
translated__content__cs__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__cs__titlestring
The title of the article.
translated__content__da__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__da__titlestring
The title of the article.
translated__content__de__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__de__titlestring
The title of the article.
translated__content__el__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__el__titlestring
The title of the article.
translated__content__en__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__en__titlestring
The title of the article.
translated__content__es__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__es__titlestring
The title of the article.
translated__content__et__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__et__titlestring
The title of the article.
translated__content__fi__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__fi__titlestring
The title of the article.
translated__content__fr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__fr__titlestring
The title of the article.
translated__content__he__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__he__titlestring
The title of the article.
translated__content__hr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__hr__titlestring
The title of the article.
translated__content__hu__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__hu__titlestring
The title of the article.
translated__content__id__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__id__titlestring
The title of the article.
translated__content__it__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__it__titlestring
The title of the article.
translated__content__ja__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ja__titlestring
The title of the article.
translated__content__ko__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ko__titlestring
The title of the article.
translated__content__lt__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__lt__titlestring
The title of the article.
translated__content__lv__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__lv__titlestring
The title of the article.
translated__content__mn__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__mn__titlestring
The title of the article.
translated__content__nb__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__nb__titlestring
The title of the article.
translated__content__nl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__nl__titlestring
The title of the article.
translated__content__pl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pl__titlestring
The title of the article.
translated__content__pt__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pt__titlestring
The title of the article.
translated__content__ro__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ro__titlestring
The title of the article.
translated__content__ru__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ru__titlestring
The title of the article.
translated__content__sl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sl__titlestring
The title of the article.
translated__content__sr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sr__titlestring
The title of the article.
translated__content__sv__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sv__titlestring
The title of the article.
translated__content__tr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__tr__titlestring
The title of the article.
translated__content__vi__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__vi__titlestring
The title of the article.
translated__content__pt__BR__urlstring
The URL of the article.
translated__content__zh__CN__urlstring
The URL of the article.
translated__content__zh__TW__urlstring
The URL of the article.
translated__content__pt__BR__bodystring
The body of the article.
translated__content__pt__BR__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__zh__CN__bodystring
The body of the article.
translated__content__zh__CN__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__zh__TW__bodystring
The body of the article.
translated__content__zh__TW__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pt__BR__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pt__BR__titlestring
The title of the article.
translated__content__zh__CN__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__zh__CN__titlestring
The title of the article.
translated__content__zh__TW__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__zh__TW__titlestring
The title of the article.
translated__content__ar__author__idinteger
The ID of the author of the article.
translated__content__bg__author__idinteger
The ID of the author of the article.
translated__content__bs__author__idinteger
The ID of the author of the article.
translated__content__ca__author__idinteger
The ID of the author of the article.
translated__content__cs__author__idinteger
The ID of the author of the article.
translated__content__da__author__idinteger
The ID of the author of the article.
translated__content__de__author__idinteger
The ID of the author of the article.
translated__content__el__author__idinteger
The ID of the author of the article.
translated__content__en__author__idinteger
The ID of the author of the article.
translated__content__es__author__idinteger
The ID of the author of the article.
translated__content__et__author__idinteger
The ID of the author of the article.
translated__content__fi__author__idinteger
The ID of the author of the article.
translated__content__fr__author__idinteger
The ID of the author of the article.
translated__content__he__author__idinteger
The ID of the author of the article.
translated__content__hr__author__idinteger
The ID of the author of the article.
translated__content__hu__author__idinteger
The ID of the author of the article.
translated__content__id__author__idinteger
The ID of the author of the article.
translated__content__it__author__idinteger
The ID of the author of the article.
translated__content__ja__author__idinteger
The ID of the author of the article.
translated__content__ko__author__idinteger
The ID of the author of the article.
translated__content__lt__author__idinteger
The ID of the author of the article.
translated__content__lv__author__idinteger
The ID of the author of the article.
translated__content__mn__author__idinteger
The ID of the author of the article.
translated__content__nb__author__idinteger
The ID of the author of the article.
translated__content__nl__author__idinteger
The ID of the author of the article.
translated__content__pl__author__idinteger
The ID of the author of the article.
translated__content__pt__author__idinteger
The ID of the author of the article.
translated__content__ro__author__idinteger
The ID of the author of the article.
translated__content__ru__author__idinteger
The ID of the author of the article.
translated__content__sl__author__idinteger
The ID of the author of the article.
translated__content__sr__author__idinteger
The ID of the author of the article.
translated__content__sv__author__idinteger
The ID of the author of the article.
translated__content__tr__author__idinteger
The ID of the author of the article.
translated__content__vi__author__idinteger
The ID of the author of the article.
translated__content__ar__created__atinteger
The time when the article was created (seconds).
translated__content__ar__descriptionstring
The description of the article.
translated__content__ar__updated__atinteger
The time when the article was last updated (seconds).
translated__content__bg__created__atinteger
The time when the article was created (seconds).
translated__content__bg__descriptionstring
The description of the article.
translated__content__bg__updated__atinteger
The time when the article was last updated (seconds).
translated__content__bs__created__atinteger
The time when the article was created (seconds).
translated__content__bs__descriptionstring
The description of the article.
translated__content__bs__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ca__created__atinteger
The time when the article was created (seconds).
translated__content__ca__descriptionstring
The description of the article.
translated__content__ca__updated__atinteger
The time when the article was last updated (seconds).
translated__content__cs__created__atinteger
The time when the article was created (seconds).
translated__content__cs__descriptionstring
The description of the article.
translated__content__cs__updated__atinteger
The time when the article was last updated (seconds).
translated__content__da__created__atinteger
The time when the article was created (seconds).
translated__content__da__descriptionstring
The description of the article.
translated__content__da__updated__atinteger
The time when the article was last updated (seconds).
translated__content__de__created__atinteger
The time when the article was created (seconds).
translated__content__de__descriptionstring
The description of the article.
translated__content__de__updated__atinteger
The time when the article was last updated (seconds).
translated__content__el__created__atinteger
The time when the article was created (seconds).
translated__content__el__descriptionstring
The description of the article.
translated__content__el__updated__atinteger
The time when the article was last updated (seconds).
translated__content__en__created__atinteger
The time when the article was created (seconds).
translated__content__en__descriptionstring
The description of the article.
translated__content__en__updated__atinteger
The time when the article was last updated (seconds).
translated__content__es__created__atinteger
The time when the article was created (seconds).
translated__content__es__descriptionstring
The description of the article.
translated__content__es__updated__atinteger
The time when the article was last updated (seconds).
translated__content__et__created__atinteger
The time when the article was created (seconds).
translated__content__et__descriptionstring
The description of the article.
translated__content__et__updated__atinteger
The time when the article was last updated (seconds).
translated__content__fi__created__atinteger
The time when the article was created (seconds).
translated__content__fi__descriptionstring
The description of the article.
translated__content__fi__updated__atinteger
The time when the article was last updated (seconds).
translated__content__fr__created__atinteger
The time when the article was created (seconds).
translated__content__fr__descriptionstring
The description of the article.
translated__content__fr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__he__created__atinteger
The time when the article was created (seconds).
translated__content__he__descriptionstring
The description of the article.
translated__content__he__updated__atinteger
The time when the article was last updated (seconds).
translated__content__hr__created__atinteger
The time when the article was created (seconds).
translated__content__hr__descriptionstring
The description of the article.
translated__content__hr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__hu__created__atinteger
The time when the article was created (seconds).
translated__content__hu__descriptionstring
The description of the article.
translated__content__hu__updated__atinteger
The time when the article was last updated (seconds).
translated__content__id__created__atinteger
The time when the article was created (seconds).
translated__content__id__descriptionstring
The description of the article.
translated__content__id__updated__atinteger
The time when the article was last updated (seconds).
translated__content__it__created__atinteger
The time when the article was created (seconds).
translated__content__it__descriptionstring
The description of the article.
translated__content__it__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ja__created__atinteger
The time when the article was created (seconds).
translated__content__ja__descriptionstring
The description of the article.
translated__content__ja__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ko__created__atinteger
The time when the article was created (seconds).
translated__content__ko__descriptionstring
The description of the article.
translated__content__ko__updated__atinteger
The time when the article was last updated (seconds).
translated__content__lt__created__atinteger
The time when the article was created (seconds).
translated__content__lt__descriptionstring
The description of the article.
translated__content__lt__updated__atinteger
The time when the article was last updated (seconds).
translated__content__lv__created__atinteger
The time when the article was created (seconds).
translated__content__lv__descriptionstring
The description of the article.
translated__content__lv__updated__atinteger
The time when the article was last updated (seconds).
translated__content__mn__created__atinteger
The time when the article was created (seconds).
translated__content__mn__descriptionstring
The description of the article.
translated__content__mn__updated__atinteger
The time when the article was last updated (seconds).
translated__content__nb__created__atinteger
The time when the article was created (seconds).
translated__content__nb__descriptionstring
The description of the article.
translated__content__nb__updated__atinteger
The time when the article was last updated (seconds).
translated__content__nl__created__atinteger
The time when the article was created (seconds).
translated__content__nl__descriptionstring
The description of the article.
translated__content__nl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pl__created__atinteger
The time when the article was created (seconds).
translated__content__pl__descriptionstring
The description of the article.
translated__content__pl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pt__created__atinteger
The time when the article was created (seconds).
translated__content__pt__descriptionstring
The description of the article.
translated__content__pt__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ro__created__atinteger
The time when the article was created (seconds).
translated__content__ro__descriptionstring
The description of the article.
translated__content__ro__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ru__created__atinteger
The time when the article was created (seconds).
translated__content__ru__descriptionstring
The description of the article.
translated__content__ru__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sl__created__atinteger
The time when the article was created (seconds).
translated__content__sl__descriptionstring
The description of the article.
translated__content__sl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sr__created__atinteger
The time when the article was created (seconds).
translated__content__sr__descriptionstring
The description of the article.
translated__content__sr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sv__created__atinteger
The time when the article was created (seconds).
translated__content__sv__descriptionstring
The description of the article.
translated__content__sv__updated__atinteger
The time when the article was last updated (seconds).
translated__content__tr__created__atinteger
The time when the article was created (seconds).
translated__content__tr__descriptionstring
The description of the article.
translated__content__tr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__vi__created__atinteger
The time when the article was created (seconds).
translated__content__vi__descriptionstring
The description of the article.
translated__content__vi__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pt__BR__author__idinteger
The ID of the author of the article.
translated__content__zh__CN__author__idinteger
The ID of the author of the article.
translated__content__zh__TW__author__idinteger
The ID of the author of the article.
translated__content__pt__BR__created__atinteger
The time when the article was created (seconds).
translated__content__pt__BR__descriptionstring
The description of the article.
translated__content__pt__BR__updated__atinteger
The time when the article was last updated (seconds).
translated__content__zh__CN__created__atinteger
The time when the article was created (seconds).
translated__content__zh__CN__descriptionstring
The description of the article.
translated__content__zh__CN__updated__atinteger
The time when the article was last updated (seconds).
translated__content__zh__TW__created__atinteger
The time when the article was created (seconds).
translated__content__zh__TW__descriptionstring
The description of the article.
translated__content__zh__TW__updated__atinteger
The time when the article was last updated (seconds).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create a noteINTERCOM_CREATE_A_NOTEAcción

You can add a note to a single contact.

Parámetros de entrada

idintegerObligatorio
The unique identifier of a given contact.
bodystringObligatorio
The text of the note.
admin_idstring
The unique identifier of a given admin.
contact_idstring
The unique identifier of a given contact.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create conversationINTERCOM_CREATE_CONVERSATIONAcción

Creates a new conversation in intercom

Parámetros de entrada

bodystringObligatorio
The message content for the conversation
subjectstring
Subject line for the conversation
from_user_idstring
ID of the user to create the conversation from. Either from_user_id or from_contact_id is required
message_typestring
Type of message: inapp, email, or facebook
from_admin_idstring
ID of the admin creating the conversation. If not provided, uses authenticated admin
from_contact_idstring
ID of the contact to create the conversation from. Either from_user_id or from_contact_id is required

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or update a companyINTERCOM_CREATE_OR_UPDATE_A_COMPANYAcción

You can create or update a company. companies will be only visible in intercom when there is at least one associated user. companies are looked up via `company id` in a `post` request, if not found via `company id`, the new company will be created, if found, that company will be updated. {% admonition type="attention" name="using `company id`" %} you can set a unique `company id` value when creating a company. however, it is not possible to update `company id`. be sure to set a unique value once upon creation of the company. {% /admonition %}

Parámetros de entrada

namestring
The name of the Company
planstring
The name of the plan you have associated with the company.
sizeinteger
The number of employees in this company.
websitestring
The URL for this company"s website. Please note that the value specified here is not validated. Accepts any string.
industrystring
The industry that this company operates in.
company_idstring
The company id you have defined for the company. Can"t be updated
monthly_spendinteger
How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..
custom_attributesobject
A hash of key/value pairs containing any other data about the company you want Intercom to store.
remote_created_atinteger
The time the company was created by you.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a collectionINTERCOM_DELETE_A_COLLECTIONAcción

You can delete a single collection by making a delete request to `https://api.intercom.io/collections/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the collection which is given by Intercom.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a companyINTERCOM_DELETE_A_COMPANYAcción

You can delete a single company.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete a contactINTERCOM_DELETE_A_CONTACTAcción

You can delete a single contact.

Parámetros de entrada

idstringObligatorio
id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete an articleINTERCOM_DELETE_AN_ARTICLEAcción

You can delete a single article by making a delete request to `https://api.intercom.io/articles/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the article which is given by Intercom.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Detach a contact from a companyINTERCOM_DETACH_A_CONTACT_FROM_A_COMPANYAcción

You can detach a company from a single contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom
contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get a contactINTERCOM_GET_A_CONTACTAcción

You can fetch the details of a single contact.

Parámetros de entrada

idstringObligatorio
id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get conversationINTERCOM_GET_CONVERSATIONAcción

Retrieves a specific conversation by id with all messages and details

Parámetros de entrada

display_asstring
Display format for message content: plaintext or html
conversation_idstringObligatorio
The ID of the conversation to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Identify an adminINTERCOM_IDENTIFY_AN_ADMINAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all activity logsINTERCOM_LIST_ALL_ACTIVITY_LOGSAcción

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

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all adminsINTERCOM_LIST_ALL_ADMINSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all articlesINTERCOM_LIST_ALL_ARTICLESAcción

You can fetch a list of all articles by making a get request to `https://api.intercom.io/articles`. > 📘 how are the articles sorted and ordered? > > articles will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated articles first.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all collectionsINTERCOM_LIST_ALL_COLLECTIONSAcción

You can fetch a list of all collections by making a get request to `https://api.intercom.io/help center/collections`. collections will be returned in descending order on the `updated at` attribute. this means if you need to iterate through results then we'll show the most recently updated collections first.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all companiesINTERCOM_LIST_ALL_COMPANIESAcción

You can list companies. the company list is sorted by the `last request at` field and by default is ordered descending, most recently requested first. note that the api does not include companies who have no associated users in list responses. when using the companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 companies that can be returned. if you need to list or iterate on more than 10,000 companies, please use the [scroll api](https://developers.intercom.com/reference#iterating-over-all-companies). {% admonition type="warning" name="pagination" %} you can use pagination to limit the number of results returned. the default is `20` results per page. see the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting after` param. {% /admonition %}

Parámetros de entrada

pageinteger
The page of results to fetch. Defaults to first page
orderstring
`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc
per_pageinteger
How many results to return per page. Defaults to 15

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all help centersINTERCOM_LIST_ALL_HELP_CENTERSAcción

You can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all notesINTERCOM_LIST_ALL_NOTESAcción

You can fetch a list of notes that are associated to a contact.

Parámetros de entrada

idintegerObligatorio
The unique identifier of a contact.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List attached companies for contactINTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACTAcción

You can fetch a list of companies that are associated to a contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List attached contactsINTERCOM_LIST_ATTACHED_CONTACTSAcción

You can fetch a list of all contacts that belong to a company.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List attached segments for companiesINTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIESAcción

You can fetch a list of all segments that belong to a company.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List attached segments for contactINTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACTAcción

You can fetch a list of segments that are associated to a contact.

Parámetros de entrada

contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List conversationsINTERCOM_LIST_CONVERSATIONSAcción

Lists conversations from intercom with filtering and pagination support

Parámetros de entrada

statestring
Filter by conversation state: open, closed, snoozed
per_pageinteger
Number of conversations per page (1-150)
display_asstring
Display format: plaintext or html
assignee_idstring
Filter by assignee admin ID
starting_afterstring
Pagination cursor - ID of the last conversation from previous page

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List subscriptions for a contactINTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACTAcción

You can fetch a list of subscription types that are attached to a contact. these can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. this will return a list of subscription type objects that the contact is associated with. the data property will show a combined list of: 1.opt-out subscription types that the user has opted-out from. 2.opt-in subscription types that the user has opted-in to receiving.

Parámetros de entrada

contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List tags attached to a contactINTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACTAcción

You can fetch a list of all tags that are attached to a specific contact.

Parámetros de entrada

contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge a lead and a userINTERCOM_MERGE_A_LEAD_AND_A_USERAcción

You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.

Parámetros de entrada

fromstring
The unique identifier for the contact to merge away from. Must be a lead.
intostring
The unique identifier for the contact to merge into. Must be a user.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove subscription from a contactINTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACTAcción

You can remove a specific subscription from a contact. this will return a subscription type model for the subscription type that was removed from the contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the subscription type which is given by Intercom
contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove tag from a contactINTERCOM_REMOVE_TAG_FROM_A_CONTACTAcción

You can remove tag from a specific contact. this will return a tag object for the tag that was removed from the contact.

Parámetros de entrada

idstringObligatorio
The unique identifier for the tag which is given by Intercom
contact_idstringObligatorio
The unique identifier for the contact which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reopen conversationINTERCOM_REOPEN_CONVERSATIONAcción

Reopens a closed conversation in intercom

Parámetros de entrada

bodystring
Optional message to send when reopening the conversation
admin_idstringObligatorio
ID of the admin reopening the conversation
conversation_idstringObligatorio
The ID of the conversation to reopen

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reply to conversationINTERCOM_REPLY_TO_CONVERSATIONAcción

Sends a reply to an existing conversation in intercom

Parámetros de entrada

admin_idstring
ID of the admin sending the reply. If not provided, uses the authenticated admin
message_bodystringObligatorio
The message content to send as a reply
message_typestring
Type of message: comment, note, or assignment
attachment_urlsstring[]
List of attachment URLs to include in the reply
conversation_idstringObligatorio
The ID of the conversation to reply to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a collectionINTERCOM_RETRIEVE_A_COLLECTIONAcción

You can fetch the details of a single collection by making a get request to `https://api.intercom.io/help center/collections/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the collection which is given by Intercom.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a company by idINTERCOM_RETRIEVE_A_COMPANY_BY_IDAcción

You can fetch a single company.

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve a help centerINTERCOM_RETRIEVE_A_HELP_CENTERAcción

You can fetch the details of a single help center by making a get request to `https://api.intercom.io/help center/help center/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the collection which is given by Intercom.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an adminINTERCOM_RETRIEVE_AN_ADMINAcción

You can retrieve the details of a single admin.

Parámetros de entrada

idintegerObligatorio
The unique identifier of a given admin

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve an articleINTERCOM_RETRIEVE_AN_ARTICLEAcción

You can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the article which is given by Intercom.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve companiesINTERCOM_RETRIEVE_COMPANIESAcción

You can fetch a single company by passing in `company id` or `name`. `https://api.intercom.io/companies?name={name}` `https://api.intercom.io/companies?company id={company id}` you can fetch all companies and filter by `segment id` or `tag id` as a query parameter. `https://api.intercom.io/companies?tag id={tag id}` `https://api.intercom.io/companies?segment id={segment id}`

Parámetros de entrada

namestring
The `name` of the company to filter by.
pageinteger
The page of results to fetch. Defaults to first page
tag_idstring
The `tag_id` of the company to filter by.
per_pageinteger
How many results to display per page. Defaults to 15
company_idstring
The `company_id` of the company to filter by.
segment_idstring
The `segment_id` of the company to filter by.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Scroll over all companiesINTERCOM_SCROLL_OVER_ALL_COMPANIESAcción

The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. the scroll api provides an efficient mechanism for iterating over all companies in a dataset. - each app can only have 1 scroll open at a time. you'll get an error message if you try to have more than one open per app. you can get the first page of companies by simply sending a get request to the scroll endpoint. for subsequent requests you will need to use the scroll parameter from the response type="danger" name="scroll network timeouts". since scroll is often used on large datasets network errors such as timeouts can be encountered. when this occurs you will see a http 500 error with the following message: "request failed due to an internal network error. please restart the scroll operation." if this happens, you will need to restart your scroll query.

Parámetros de entrada

scroll_paramstring
Scroll Param

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search conversationsINTERCOM_SEARCH_CONVERSATIONSAcción

Searches for conversations using query string with support for filtering and sorting

Parámetros de entrada

querystringObligatorio
Search query string to find conversations
per_pageinteger
Number of conversations per page (1-150)
sort_fieldstring
Field to sort by: created_at, updated_at, waiting_since
sort_orderstring
Sort order: ascending or descending
starting_afterstring
Pagination cursor - ID of the last conversation from previous page

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search for articlesINTERCOM_SEARCH_FOR_ARTICLESAcción

You can search for articles by making a get request to `https://api.intercom.io/articles/search`.

Parámetros de entrada

statestring
The state of the Articles returned. One of `published`, `draft` or `all`.
phrasestring
The phrase within your articles to search for.
highlightboolean
Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.
help_center_idinteger
The ID of the Help Center to search in.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set an admin to awayINTERCOM_SET_AN_ADMIN_TO_AWAYAcción

You can set an admin as away for the inbox.

Parámetros de entrada

idintegerObligatorio
The unique identifier of a given admin
away_mode_enabledboolean
Set to "true" to change the status of the admin to away.
away_mode_reassignboolean
Set to "true" to assign any new conversation replies to your default inbox.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a collectionINTERCOM_UPDATE_A_COLLECTIONAcción

You can update the details of a single collection by making a put request to `https://api.intercom.io/collections/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the collection which is given by Intercom.
namestring
The name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstring
The id of the parent collection. If `null` then it will be updated as the first level collection.
descriptionstring
The description of the collection. For multilingual collections, this will be the description of the default language"s content.
translated__content__typestringenum
The type of object - group_translated_content.
Nonegroup_translated_content
translated__content__ar__namestring
The name of the collection or section.
translated__content__ar__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__bg__namestring
The name of the collection or section.
translated__content__bg__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__bs__namestring
The name of the collection or section.
translated__content__bs__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ca__namestring
The name of the collection or section.
translated__content__ca__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__cs__namestring
The name of the collection or section.
translated__content__cs__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__da__namestring
The name of the collection or section.
translated__content__da__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__de__namestring
The name of the collection or section.
translated__content__de__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__el__namestring
The name of the collection or section.
translated__content__el__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__en__namestring
The name of the collection or section.
translated__content__en__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__es__namestring
The name of the collection or section.
translated__content__es__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__et__namestring
The name of the collection or section.
translated__content__et__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__fi__namestring
The name of the collection or section.
translated__content__fi__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__fr__namestring
The name of the collection or section.
translated__content__fr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__he__namestring
The name of the collection or section.
translated__content__he__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__hr__namestring
The name of the collection or section.
translated__content__hr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__hu__namestring
The name of the collection or section.
translated__content__hu__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__id__namestring
The name of the collection or section.
translated__content__id__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__it__namestring
The name of the collection or section.
translated__content__it__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ja__namestring
The name of the collection or section.
translated__content__ja__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ko__namestring
The name of the collection or section.
translated__content__ko__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__lt__namestring
The name of the collection or section.
translated__content__lt__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__lv__namestring
The name of the collection or section.
translated__content__lv__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__mn__namestring
The name of the collection or section.
translated__content__mn__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__nb__namestring
The name of the collection or section.
translated__content__nb__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__nl__namestring
The name of the collection or section.
translated__content__nl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pl__namestring
The name of the collection or section.
translated__content__pl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pt__namestring
The name of the collection or section.
translated__content__pt__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ro__namestring
The name of the collection or section.
translated__content__ro__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ru__namestring
The name of the collection or section.
translated__content__ru__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sl__namestring
The name of the collection or section.
translated__content__sl__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sr__namestring
The name of the collection or section.
translated__content__sr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__sv__namestring
The name of the collection or section.
translated__content__sv__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__tr__namestring
The name of the collection or section.
translated__content__tr__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__vi__namestring
The name of the collection or section.
translated__content__vi__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__pt__BR__namestring
The name of the collection or section.
translated__content__pt__BR__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__zh__CN__namestring
The name of the collection or section.
translated__content__zh__CN__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__zh__TW__namestring
The name of the collection or section.
translated__content__zh__TW__typestringenum
The type of object - `group_content` .
Nonegroup_content
translated__content__ar__descriptionstring
The description of the collection. Only available for collections.
translated__content__bg__descriptionstring
The description of the collection. Only available for collections.
translated__content__bs__descriptionstring
The description of the collection. Only available for collections.
translated__content__ca__descriptionstring
The description of the collection. Only available for collections.
translated__content__cs__descriptionstring
The description of the collection. Only available for collections.
translated__content__da__descriptionstring
The description of the collection. Only available for collections.
translated__content__de__descriptionstring
The description of the collection. Only available for collections.
translated__content__el__descriptionstring
The description of the collection. Only available for collections.
translated__content__en__descriptionstring
The description of the collection. Only available for collections.
translated__content__es__descriptionstring
The description of the collection. Only available for collections.
translated__content__et__descriptionstring
The description of the collection. Only available for collections.
translated__content__fi__descriptionstring
The description of the collection. Only available for collections.
translated__content__fr__descriptionstring
The description of the collection. Only available for collections.
translated__content__he__descriptionstring
The description of the collection. Only available for collections.
translated__content__hr__descriptionstring
The description of the collection. Only available for collections.
translated__content__hu__descriptionstring
The description of the collection. Only available for collections.
translated__content__id__descriptionstring
The description of the collection. Only available for collections.
translated__content__it__descriptionstring
The description of the collection. Only available for collections.
translated__content__ja__descriptionstring
The description of the collection. Only available for collections.
translated__content__ko__descriptionstring
The description of the collection. Only available for collections.
translated__content__lt__descriptionstring
The description of the collection. Only available for collections.
translated__content__lv__descriptionstring
The description of the collection. Only available for collections.
translated__content__mn__descriptionstring
The description of the collection. Only available for collections.
translated__content__nb__descriptionstring
The description of the collection. Only available for collections.
translated__content__nl__descriptionstring
The description of the collection. Only available for collections.
translated__content__pl__descriptionstring
The description of the collection. Only available for collections.
translated__content__pt__descriptionstring
The description of the collection. Only available for collections.
translated__content__ro__descriptionstring
The description of the collection. Only available for collections.
translated__content__ru__descriptionstring
The description of the collection. Only available for collections.
translated__content__sl__descriptionstring
The description of the collection. Only available for collections.
translated__content__sr__descriptionstring
The description of the collection. Only available for collections.
translated__content__sv__descriptionstring
The description of the collection. Only available for collections.
translated__content__tr__descriptionstring
The description of the collection. Only available for collections.
translated__content__vi__descriptionstring
The description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstring
The description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstring
The description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstring
The description of the collection. Only available for collections.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a companyINTERCOM_UPDATE_A_COMPANYAcción

You can update a single company using the intercom provisioned `id`. {% admonition type="attention" name="using `company id`" %} when updating a company it is not possible to update `company id`. this can only be set once upon creation of the company. {% /admonition %}

Parámetros de entrada

idstringObligatorio
The unique identifier for the company which is given by Intercom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update a contactINTERCOM_UPDATE_A_CONTACTAcción

You can update an existing contact (ie. user or lead).

Parámetros de entrada

idstringObligatorio
id

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update an articleINTERCOM_UPDATE_AN_ARTICLEAcción

You can update the details of a single article by making a put request to `https://api.intercom.io/articles/<id>`.

Parámetros de entrada

idintegerObligatorio
The unique identifier for the article which is given by Intercom.
bodystring
The content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringenum
Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language"s content.
publisheddraft
titlestring
The title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idinteger
The id of the author of the article. For multilingual articles, this will be the id of the author of the default language"s content. Must be a teammate on the help center"s workspace.
parent_idstring
The id of the article"s parent collection or section. An article without this field stands alone.
descriptionstring
The description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestring
The type of parent, which can either be a `collection` or `section`.
translated__content__typestringenum
The type of object - article_translated_content.
Nonearticle_translated_content
translated__content__ar__urlstring
The URL of the article.
translated__content__bg__urlstring
The URL of the article.
translated__content__bs__urlstring
The URL of the article.
translated__content__ca__urlstring
The URL of the article.
translated__content__cs__urlstring
The URL of the article.
translated__content__da__urlstring
The URL of the article.
translated__content__de__urlstring
The URL of the article.
translated__content__el__urlstring
The URL of the article.
translated__content__en__urlstring
The URL of the article.
translated__content__es__urlstring
The URL of the article.
translated__content__et__urlstring
The URL of the article.
translated__content__fi__urlstring
The URL of the article.
translated__content__fr__urlstring
The URL of the article.
translated__content__he__urlstring
The URL of the article.
translated__content__hr__urlstring
The URL of the article.
translated__content__hu__urlstring
The URL of the article.
translated__content__id__urlstring
The URL of the article.
translated__content__it__urlstring
The URL of the article.
translated__content__ja__urlstring
The URL of the article.
translated__content__ko__urlstring
The URL of the article.
translated__content__lt__urlstring
The URL of the article.
translated__content__lv__urlstring
The URL of the article.
translated__content__mn__urlstring
The URL of the article.
translated__content__nb__urlstring
The URL of the article.
translated__content__nl__urlstring
The URL of the article.
translated__content__pl__urlstring
The URL of the article.
translated__content__pt__urlstring
The URL of the article.
translated__content__ro__urlstring
The URL of the article.
translated__content__ru__urlstring
The URL of the article.
translated__content__sl__urlstring
The URL of the article.
translated__content__sr__urlstring
The URL of the article.
translated__content__sv__urlstring
The URL of the article.
translated__content__tr__urlstring
The URL of the article.
translated__content__vi__urlstring
The URL of the article.
translated__content__ar__bodystring
The body of the article.
translated__content__ar__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__bg__bodystring
The body of the article.
translated__content__bg__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__bs__bodystring
The body of the article.
translated__content__bs__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ca__bodystring
The body of the article.
translated__content__ca__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__cs__bodystring
The body of the article.
translated__content__cs__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__da__bodystring
The body of the article.
translated__content__da__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__de__bodystring
The body of the article.
translated__content__de__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__el__bodystring
The body of the article.
translated__content__el__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__en__bodystring
The body of the article.
translated__content__en__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__es__bodystring
The body of the article.
translated__content__es__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__et__bodystring
The body of the article.
translated__content__et__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__fi__bodystring
The body of the article.
translated__content__fi__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__fr__bodystring
The body of the article.
translated__content__fr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__he__bodystring
The body of the article.
translated__content__he__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__hr__bodystring
The body of the article.
translated__content__hr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__hu__bodystring
The body of the article.
translated__content__hu__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__id__bodystring
The body of the article.
translated__content__id__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__it__bodystring
The body of the article.
translated__content__it__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ja__bodystring
The body of the article.
translated__content__ja__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ko__bodystring
The body of the article.
translated__content__ko__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__lt__bodystring
The body of the article.
translated__content__lt__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__lv__bodystring
The body of the article.
translated__content__lv__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__mn__bodystring
The body of the article.
translated__content__mn__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__nb__bodystring
The body of the article.
translated__content__nb__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__nl__bodystring
The body of the article.
translated__content__nl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pl__bodystring
The body of the article.
translated__content__pl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pt__bodystring
The body of the article.
translated__content__pt__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ro__bodystring
The body of the article.
translated__content__ro__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ru__bodystring
The body of the article.
translated__content__ru__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sl__bodystring
The body of the article.
translated__content__sl__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sr__bodystring
The body of the article.
translated__content__sr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__sv__bodystring
The body of the article.
translated__content__sv__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__tr__bodystring
The body of the article.
translated__content__tr__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__vi__bodystring
The body of the article.
translated__content__vi__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__ar__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ar__titlestring
The title of the article.
translated__content__bg__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__bg__titlestring
The title of the article.
translated__content__bs__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__bs__titlestring
The title of the article.
translated__content__ca__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ca__titlestring
The title of the article.
translated__content__cs__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__cs__titlestring
The title of the article.
translated__content__da__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__da__titlestring
The title of the article.
translated__content__de__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__de__titlestring
The title of the article.
translated__content__el__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__el__titlestring
The title of the article.
translated__content__en__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__en__titlestring
The title of the article.
translated__content__es__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__es__titlestring
The title of the article.
translated__content__et__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__et__titlestring
The title of the article.
translated__content__fi__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__fi__titlestring
The title of the article.
translated__content__fr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__fr__titlestring
The title of the article.
translated__content__he__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__he__titlestring
The title of the article.
translated__content__hr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__hr__titlestring
The title of the article.
translated__content__hu__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__hu__titlestring
The title of the article.
translated__content__id__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__id__titlestring
The title of the article.
translated__content__it__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__it__titlestring
The title of the article.
translated__content__ja__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ja__titlestring
The title of the article.
translated__content__ko__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ko__titlestring
The title of the article.
translated__content__lt__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__lt__titlestring
The title of the article.
translated__content__lv__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__lv__titlestring
The title of the article.
translated__content__mn__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__mn__titlestring
The title of the article.
translated__content__nb__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__nb__titlestring
The title of the article.
translated__content__nl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__nl__titlestring
The title of the article.
translated__content__pl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pl__titlestring
The title of the article.
translated__content__pt__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pt__titlestring
The title of the article.
translated__content__ro__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ro__titlestring
The title of the article.
translated__content__ru__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__ru__titlestring
The title of the article.
translated__content__sl__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sl__titlestring
The title of the article.
translated__content__sr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sr__titlestring
The title of the article.
translated__content__sv__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__sv__titlestring
The title of the article.
translated__content__tr__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__tr__titlestring
The title of the article.
translated__content__vi__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__vi__titlestring
The title of the article.
translated__content__pt__BR__urlstring
The URL of the article.
translated__content__zh__CN__urlstring
The URL of the article.
translated__content__zh__TW__urlstring
The URL of the article.
translated__content__pt__BR__bodystring
The body of the article.
translated__content__pt__BR__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__zh__CN__bodystring
The body of the article.
translated__content__zh__CN__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__zh__TW__bodystring
The body of the article.
translated__content__zh__TW__typestringenum
The type of object - `article_content` .
Nonearticle_content
translated__content__pt__BR__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__pt__BR__titlestring
The title of the article.
translated__content__zh__CN__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__zh__CN__titlestring
The title of the article.
translated__content__zh__TW__statestringenum
Whether the article is `published` or is a `draft` .
publisheddraft
translated__content__zh__TW__titlestring
The title of the article.
translated__content__ar__author__idinteger
The ID of the author of the article.
translated__content__bg__author__idinteger
The ID of the author of the article.
translated__content__bs__author__idinteger
The ID of the author of the article.
translated__content__ca__author__idinteger
The ID of the author of the article.
translated__content__cs__author__idinteger
The ID of the author of the article.
translated__content__da__author__idinteger
The ID of the author of the article.
translated__content__de__author__idinteger
The ID of the author of the article.
translated__content__el__author__idinteger
The ID of the author of the article.
translated__content__en__author__idinteger
The ID of the author of the article.
translated__content__es__author__idinteger
The ID of the author of the article.
translated__content__et__author__idinteger
The ID of the author of the article.
translated__content__fi__author__idinteger
The ID of the author of the article.
translated__content__fr__author__idinteger
The ID of the author of the article.
translated__content__he__author__idinteger
The ID of the author of the article.
translated__content__hr__author__idinteger
The ID of the author of the article.
translated__content__hu__author__idinteger
The ID of the author of the article.
translated__content__id__author__idinteger
The ID of the author of the article.
translated__content__it__author__idinteger
The ID of the author of the article.
translated__content__ja__author__idinteger
The ID of the author of the article.
translated__content__ko__author__idinteger
The ID of the author of the article.
translated__content__lt__author__idinteger
The ID of the author of the article.
translated__content__lv__author__idinteger
The ID of the author of the article.
translated__content__mn__author__idinteger
The ID of the author of the article.
translated__content__nb__author__idinteger
The ID of the author of the article.
translated__content__nl__author__idinteger
The ID of the author of the article.
translated__content__pl__author__idinteger
The ID of the author of the article.
translated__content__pt__author__idinteger
The ID of the author of the article.
translated__content__ro__author__idinteger
The ID of the author of the article.
translated__content__ru__author__idinteger
The ID of the author of the article.
translated__content__sl__author__idinteger
The ID of the author of the article.
translated__content__sr__author__idinteger
The ID of the author of the article.
translated__content__sv__author__idinteger
The ID of the author of the article.
translated__content__tr__author__idinteger
The ID of the author of the article.
translated__content__vi__author__idinteger
The ID of the author of the article.
translated__content__ar__created__atinteger
The time when the article was created (seconds).
translated__content__ar__descriptionstring
The description of the article.
translated__content__ar__updated__atinteger
The time when the article was last updated (seconds).
translated__content__bg__created__atinteger
The time when the article was created (seconds).
translated__content__bg__descriptionstring
The description of the article.
translated__content__bg__updated__atinteger
The time when the article was last updated (seconds).
translated__content__bs__created__atinteger
The time when the article was created (seconds).
translated__content__bs__descriptionstring
The description of the article.
translated__content__bs__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ca__created__atinteger
The time when the article was created (seconds).
translated__content__ca__descriptionstring
The description of the article.
translated__content__ca__updated__atinteger
The time when the article was last updated (seconds).
translated__content__cs__created__atinteger
The time when the article was created (seconds).
translated__content__cs__descriptionstring
The description of the article.
translated__content__cs__updated__atinteger
The time when the article was last updated (seconds).
translated__content__da__created__atinteger
The time when the article was created (seconds).
translated__content__da__descriptionstring
The description of the article.
translated__content__da__updated__atinteger
The time when the article was last updated (seconds).
translated__content__de__created__atinteger
The time when the article was created (seconds).
translated__content__de__descriptionstring
The description of the article.
translated__content__de__updated__atinteger
The time when the article was last updated (seconds).
translated__content__el__created__atinteger
The time when the article was created (seconds).
translated__content__el__descriptionstring
The description of the article.
translated__content__el__updated__atinteger
The time when the article was last updated (seconds).
translated__content__en__created__atinteger
The time when the article was created (seconds).
translated__content__en__descriptionstring
The description of the article.
translated__content__en__updated__atinteger
The time when the article was last updated (seconds).
translated__content__es__created__atinteger
The time when the article was created (seconds).
translated__content__es__descriptionstring
The description of the article.
translated__content__es__updated__atinteger
The time when the article was last updated (seconds).
translated__content__et__created__atinteger
The time when the article was created (seconds).
translated__content__et__descriptionstring
The description of the article.
translated__content__et__updated__atinteger
The time when the article was last updated (seconds).
translated__content__fi__created__atinteger
The time when the article was created (seconds).
translated__content__fi__descriptionstring
The description of the article.
translated__content__fi__updated__atinteger
The time when the article was last updated (seconds).
translated__content__fr__created__atinteger
The time when the article was created (seconds).
translated__content__fr__descriptionstring
The description of the article.
translated__content__fr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__he__created__atinteger
The time when the article was created (seconds).
translated__content__he__descriptionstring
The description of the article.
translated__content__he__updated__atinteger
The time when the article was last updated (seconds).
translated__content__hr__created__atinteger
The time when the article was created (seconds).
translated__content__hr__descriptionstring
The description of the article.
translated__content__hr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__hu__created__atinteger
The time when the article was created (seconds).
translated__content__hu__descriptionstring
The description of the article.
translated__content__hu__updated__atinteger
The time when the article was last updated (seconds).
translated__content__id__created__atinteger
The time when the article was created (seconds).
translated__content__id__descriptionstring
The description of the article.
translated__content__id__updated__atinteger
The time when the article was last updated (seconds).
translated__content__it__created__atinteger
The time when the article was created (seconds).
translated__content__it__descriptionstring
The description of the article.
translated__content__it__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ja__created__atinteger
The time when the article was created (seconds).
translated__content__ja__descriptionstring
The description of the article.
translated__content__ja__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ko__created__atinteger
The time when the article was created (seconds).
translated__content__ko__descriptionstring
The description of the article.
translated__content__ko__updated__atinteger
The time when the article was last updated (seconds).
translated__content__lt__created__atinteger
The time when the article was created (seconds).
translated__content__lt__descriptionstring
The description of the article.
translated__content__lt__updated__atinteger
The time when the article was last updated (seconds).
translated__content__lv__created__atinteger
The time when the article was created (seconds).
translated__content__lv__descriptionstring
The description of the article.
translated__content__lv__updated__atinteger
The time when the article was last updated (seconds).
translated__content__mn__created__atinteger
The time when the article was created (seconds).
translated__content__mn__descriptionstring
The description of the article.
translated__content__mn__updated__atinteger
The time when the article was last updated (seconds).
translated__content__nb__created__atinteger
The time when the article was created (seconds).
translated__content__nb__descriptionstring
The description of the article.
translated__content__nb__updated__atinteger
The time when the article was last updated (seconds).
translated__content__nl__created__atinteger
The time when the article was created (seconds).
translated__content__nl__descriptionstring
The description of the article.
translated__content__nl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pl__created__atinteger
The time when the article was created (seconds).
translated__content__pl__descriptionstring
The description of the article.
translated__content__pl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pt__created__atinteger
The time when the article was created (seconds).
translated__content__pt__descriptionstring
The description of the article.
translated__content__pt__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ro__created__atinteger
The time when the article was created (seconds).
translated__content__ro__descriptionstring
The description of the article.
translated__content__ro__updated__atinteger
The time when the article was last updated (seconds).
translated__content__ru__created__atinteger
The time when the article was created (seconds).
translated__content__ru__descriptionstring
The description of the article.
translated__content__ru__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sl__created__atinteger
The time when the article was created (seconds).
translated__content__sl__descriptionstring
The description of the article.
translated__content__sl__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sr__created__atinteger
The time when the article was created (seconds).
translated__content__sr__descriptionstring
The description of the article.
translated__content__sr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__sv__created__atinteger
The time when the article was created (seconds).
translated__content__sv__descriptionstring
The description of the article.
translated__content__sv__updated__atinteger
The time when the article was last updated (seconds).
translated__content__tr__created__atinteger
The time when the article was created (seconds).
translated__content__tr__descriptionstring
The description of the article.
translated__content__tr__updated__atinteger
The time when the article was last updated (seconds).
translated__content__vi__created__atinteger
The time when the article was created (seconds).
translated__content__vi__descriptionstring
The description of the article.
translated__content__vi__updated__atinteger
The time when the article was last updated (seconds).
translated__content__pt__BR__author__idinteger
The ID of the author of the article.
translated__content__zh__CN__author__idinteger
The ID of the author of the article.
translated__content__zh__TW__author__idinteger
The ID of the author of the article.
translated__content__pt__BR__created__atinteger
The time when the article was created (seconds).
translated__content__pt__BR__descriptionstring
The description of the article.
translated__content__pt__BR__updated__atinteger
The time when the article was last updated (seconds).
translated__content__zh__CN__created__atinteger
The time when the article was created (seconds).
translated__content__zh__CN__descriptionstring
The description of the article.
translated__content__zh__CN__updated__atinteger
The time when the article was last updated (seconds).
translated__content__zh__TW__created__atinteger
The time when the article was created (seconds).
translated__content__zh__TW__descriptionstring
The description of the article.
translated__content__zh__TW__updated__atinteger
The time when the article was last updated (seconds).

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not