Intercom
intercomIntercom provides live chat, messaging, and customer engagement tools, enabling businesses to drive conversions, handle support, and personalize communication at scale
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ónYou 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.
INTERCOM_ADD_SUBSCRIPTION_TO_A_CONTACTAcciónYou 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
idstringObligatorioThe unique identifier for the subscription which is given by Intercom
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
consent_typestringObligatorioThe consent_type of a subscription, opt_out or opt_in.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add tag to a contactINTERCOM_ADD_TAG_TO_A_CONTACTAcciónYou can tag a specific contact. this will return a tag object for the tag that was added to the contact.
INTERCOM_ADD_TAG_TO_A_CONTACTAcciónYou can tag a specific contact. this will return a tag object for the tag that was added to the contact.
Parámetros de entrada
idstringObligatorioThe unique identifier for the tag which is given by Intercom
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Assign conversationINTERCOM_ASSIGN_CONVERSATIONAcciónAssigns a conversation to a specific admin or team in intercom
INTERCOM_ASSIGN_CONVERSATIONAcciónAssigns a conversation to a specific admin or team in intercom
Parámetros de entrada
team_idstringID of the team to assign the conversation to. Either admin_id or team_id must be provided
admin_idstringID of the admin to assign the conversation to. Either admin_id or team_id must be provided
assignee_idstringID of the admin making the assignment (who is performing this action)
conversation_idstringObligatorioThe ID of the conversation to assign
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Attach a contact to a companyINTERCOM_ATTACH_A_CONTACT_TO_A_COMPANYAcciónYou can attach a company to a single contact.
INTERCOM_ATTACH_A_CONTACT_TO_A_COMPANYAcciónYou can attach a company to a single contact.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Close conversationINTERCOM_CLOSE_CONVERSATIONAcciónCloses a conversation in intercom, marking it as resolved
INTERCOM_CLOSE_CONVERSATIONAcciónCloses a conversation in intercom, marking it as resolved
Parámetros de entrada
bodystringOptional message to send when closing the conversation
admin_idstringObligatorioID of the admin closing the conversation
conversation_idstringObligatorioThe ID of the conversation to close
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a collectionINTERCOM_CREATE_A_COLLECTIONAcciónYou can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`
INTERCOM_CREATE_A_COLLECTIONAcciónYou can create a new collection by making a post request to `https://api.intercom.io/help center/collections.`
Parámetros de entrada
namestringObligatorioThe name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstringThe id of the parent collection. If `null` then it will be created as the first level collection.
descriptionstringThe description of the collection. For multilingual collections, this will be the description of the default language"s content.
help_center_idintegerThe 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__typestringenumThe type of object - group_translated_content.
Nonegroup_translated_contenttranslated__content__ar__namestringThe name of the collection or section.
translated__content__ar__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__bg__namestringThe name of the collection or section.
translated__content__bg__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__bs__namestringThe name of the collection or section.
translated__content__bs__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ca__namestringThe name of the collection or section.
translated__content__ca__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__cs__namestringThe name of the collection or section.
translated__content__cs__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__da__namestringThe name of the collection or section.
translated__content__da__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__de__namestringThe name of the collection or section.
translated__content__de__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__el__namestringThe name of the collection or section.
translated__content__el__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__en__namestringThe name of the collection or section.
translated__content__en__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__es__namestringThe name of the collection or section.
translated__content__es__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__et__namestringThe name of the collection or section.
translated__content__et__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__fi__namestringThe name of the collection or section.
translated__content__fi__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__fr__namestringThe name of the collection or section.
translated__content__fr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__he__namestringThe name of the collection or section.
translated__content__he__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__hr__namestringThe name of the collection or section.
translated__content__hr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__hu__namestringThe name of the collection or section.
translated__content__hu__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__id__namestringThe name of the collection or section.
translated__content__id__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__it__namestringThe name of the collection or section.
translated__content__it__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ja__namestringThe name of the collection or section.
translated__content__ja__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ko__namestringThe name of the collection or section.
translated__content__ko__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__lt__namestringThe name of the collection or section.
translated__content__lt__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__lv__namestringThe name of the collection or section.
translated__content__lv__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__mn__namestringThe name of the collection or section.
translated__content__mn__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__nb__namestringThe name of the collection or section.
translated__content__nb__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__nl__namestringThe name of the collection or section.
translated__content__nl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pl__namestringThe name of the collection or section.
translated__content__pl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pt__namestringThe name of the collection or section.
translated__content__pt__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ro__namestringThe name of the collection or section.
translated__content__ro__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ru__namestringThe name of the collection or section.
translated__content__ru__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sl__namestringThe name of the collection or section.
translated__content__sl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sr__namestringThe name of the collection or section.
translated__content__sr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sv__namestringThe name of the collection or section.
translated__content__sv__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__tr__namestringThe name of the collection or section.
translated__content__tr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__vi__namestringThe name of the collection or section.
translated__content__vi__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pt__BR__namestringThe name of the collection or section.
translated__content__pt__BR__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__zh__CN__namestringThe name of the collection or section.
translated__content__zh__CN__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__zh__TW__namestringThe name of the collection or section.
translated__content__zh__TW__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ar__descriptionstringThe description of the collection. Only available for collections.
translated__content__bg__descriptionstringThe description of the collection. Only available for collections.
translated__content__bs__descriptionstringThe description of the collection. Only available for collections.
translated__content__ca__descriptionstringThe description of the collection. Only available for collections.
translated__content__cs__descriptionstringThe description of the collection. Only available for collections.
translated__content__da__descriptionstringThe description of the collection. Only available for collections.
translated__content__de__descriptionstringThe description of the collection. Only available for collections.
translated__content__el__descriptionstringThe description of the collection. Only available for collections.
translated__content__en__descriptionstringThe description of the collection. Only available for collections.
translated__content__es__descriptionstringThe description of the collection. Only available for collections.
translated__content__et__descriptionstringThe description of the collection. Only available for collections.
translated__content__fi__descriptionstringThe description of the collection. Only available for collections.
translated__content__fr__descriptionstringThe description of the collection. Only available for collections.
translated__content__he__descriptionstringThe description of the collection. Only available for collections.
translated__content__hr__descriptionstringThe description of the collection. Only available for collections.
translated__content__hu__descriptionstringThe description of the collection. Only available for collections.
translated__content__id__descriptionstringThe description of the collection. Only available for collections.
translated__content__it__descriptionstringThe description of the collection. Only available for collections.
translated__content__ja__descriptionstringThe description of the collection. Only available for collections.
translated__content__ko__descriptionstringThe description of the collection. Only available for collections.
translated__content__lt__descriptionstringThe description of the collection. Only available for collections.
translated__content__lv__descriptionstringThe description of the collection. Only available for collections.
translated__content__mn__descriptionstringThe description of the collection. Only available for collections.
translated__content__nb__descriptionstringThe description of the collection. Only available for collections.
translated__content__nl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__descriptionstringThe description of the collection. Only available for collections.
translated__content__ro__descriptionstringThe description of the collection. Only available for collections.
translated__content__ru__descriptionstringThe description of the collection. Only available for collections.
translated__content__sl__descriptionstringThe description of the collection. Only available for collections.
translated__content__sr__descriptionstringThe description of the collection. Only available for collections.
translated__content__sv__descriptionstringThe description of the collection. Only available for collections.
translated__content__tr__descriptionstringThe description of the collection. Only available for collections.
translated__content__vi__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstringThe description of the collection. Only available for collections.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create an articleINTERCOM_CREATE_AN_ARTICLEAcciónYou can create a new article by making a post request to `https://api.intercom.io/articles`.
INTERCOM_CREATE_AN_ARTICLEAcciónYou can create a new article by making a post request to `https://api.intercom.io/articles`.
Parámetros de entrada
bodystringThe content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringenumWhether 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.
publisheddrafttitlestringObligatorioThe title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idintegerObligatorioThe 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_idintegerThe id of the article"s parent collection or section. An article without this field stands alone.
descriptionstringThe description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestringThe type of parent, which can either be a `collection` or `section`.
translated__content__typestringenumThe type of object - article_translated_content.
Nonearticle_translated_contenttranslated__content__ar__urlstringThe URL of the article.
translated__content__bg__urlstringThe URL of the article.
translated__content__bs__urlstringThe URL of the article.
translated__content__ca__urlstringThe URL of the article.
translated__content__cs__urlstringThe URL of the article.
translated__content__da__urlstringThe URL of the article.
translated__content__de__urlstringThe URL of the article.
translated__content__el__urlstringThe URL of the article.
translated__content__en__urlstringThe URL of the article.
translated__content__es__urlstringThe URL of the article.
translated__content__et__urlstringThe URL of the article.
translated__content__fi__urlstringThe URL of the article.
translated__content__fr__urlstringThe URL of the article.
translated__content__he__urlstringThe URL of the article.
translated__content__hr__urlstringThe URL of the article.
translated__content__hu__urlstringThe URL of the article.
translated__content__id__urlstringThe URL of the article.
translated__content__it__urlstringThe URL of the article.
translated__content__ja__urlstringThe URL of the article.
translated__content__ko__urlstringThe URL of the article.
translated__content__lt__urlstringThe URL of the article.
translated__content__lv__urlstringThe URL of the article.
translated__content__mn__urlstringThe URL of the article.
translated__content__nb__urlstringThe URL of the article.
translated__content__nl__urlstringThe URL of the article.
translated__content__pl__urlstringThe URL of the article.
translated__content__pt__urlstringThe URL of the article.
translated__content__ro__urlstringThe URL of the article.
translated__content__ru__urlstringThe URL of the article.
translated__content__sl__urlstringThe URL of the article.
translated__content__sr__urlstringThe URL of the article.
translated__content__sv__urlstringThe URL of the article.
translated__content__tr__urlstringThe URL of the article.
translated__content__vi__urlstringThe URL of the article.
translated__content__ar__bodystringThe body of the article.
translated__content__ar__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__bg__bodystringThe body of the article.
translated__content__bg__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__bs__bodystringThe body of the article.
translated__content__bs__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ca__bodystringThe body of the article.
translated__content__ca__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__cs__bodystringThe body of the article.
translated__content__cs__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__da__bodystringThe body of the article.
translated__content__da__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__de__bodystringThe body of the article.
translated__content__de__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__el__bodystringThe body of the article.
translated__content__el__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__en__bodystringThe body of the article.
translated__content__en__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__es__bodystringThe body of the article.
translated__content__es__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__et__bodystringThe body of the article.
translated__content__et__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__fi__bodystringThe body of the article.
translated__content__fi__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__fr__bodystringThe body of the article.
translated__content__fr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__he__bodystringThe body of the article.
translated__content__he__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__hr__bodystringThe body of the article.
translated__content__hr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__hu__bodystringThe body of the article.
translated__content__hu__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__id__bodystringThe body of the article.
translated__content__id__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__it__bodystringThe body of the article.
translated__content__it__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ja__bodystringThe body of the article.
translated__content__ja__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ko__bodystringThe body of the article.
translated__content__ko__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__lt__bodystringThe body of the article.
translated__content__lt__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__lv__bodystringThe body of the article.
translated__content__lv__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__mn__bodystringThe body of the article.
translated__content__mn__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__nb__bodystringThe body of the article.
translated__content__nb__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__nl__bodystringThe body of the article.
translated__content__nl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pl__bodystringThe body of the article.
translated__content__pl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pt__bodystringThe body of the article.
translated__content__pt__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ro__bodystringThe body of the article.
translated__content__ro__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ru__bodystringThe body of the article.
translated__content__ru__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sl__bodystringThe body of the article.
translated__content__sl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sr__bodystringThe body of the article.
translated__content__sr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sv__bodystringThe body of the article.
translated__content__sv__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__tr__bodystringThe body of the article.
translated__content__tr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__vi__bodystringThe body of the article.
translated__content__vi__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ar__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ar__titlestringThe title of the article.
translated__content__bg__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__bg__titlestringThe title of the article.
translated__content__bs__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__bs__titlestringThe title of the article.
translated__content__ca__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ca__titlestringThe title of the article.
translated__content__cs__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__cs__titlestringThe title of the article.
translated__content__da__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__da__titlestringThe title of the article.
translated__content__de__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__de__titlestringThe title of the article.
translated__content__el__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__el__titlestringThe title of the article.
translated__content__en__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__en__titlestringThe title of the article.
translated__content__es__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__es__titlestringThe title of the article.
translated__content__et__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__et__titlestringThe title of the article.
translated__content__fi__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__fi__titlestringThe title of the article.
translated__content__fr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__fr__titlestringThe title of the article.
translated__content__he__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__he__titlestringThe title of the article.
translated__content__hr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__hr__titlestringThe title of the article.
translated__content__hu__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__hu__titlestringThe title of the article.
translated__content__id__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__id__titlestringThe title of the article.
translated__content__it__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__it__titlestringThe title of the article.
translated__content__ja__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ja__titlestringThe title of the article.
translated__content__ko__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ko__titlestringThe title of the article.
translated__content__lt__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__lt__titlestringThe title of the article.
translated__content__lv__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__lv__titlestringThe title of the article.
translated__content__mn__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__mn__titlestringThe title of the article.
translated__content__nb__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__nb__titlestringThe title of the article.
translated__content__nl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__nl__titlestringThe title of the article.
translated__content__pl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pl__titlestringThe title of the article.
translated__content__pt__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pt__titlestringThe title of the article.
translated__content__ro__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ro__titlestringThe title of the article.
translated__content__ru__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ru__titlestringThe title of the article.
translated__content__sl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sl__titlestringThe title of the article.
translated__content__sr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sr__titlestringThe title of the article.
translated__content__sv__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sv__titlestringThe title of the article.
translated__content__tr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__tr__titlestringThe title of the article.
translated__content__vi__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__vi__titlestringThe title of the article.
translated__content__pt__BR__urlstringThe URL of the article.
translated__content__zh__CN__urlstringThe URL of the article.
translated__content__zh__TW__urlstringThe URL of the article.
translated__content__pt__BR__bodystringThe body of the article.
translated__content__pt__BR__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__zh__CN__bodystringThe body of the article.
translated__content__zh__CN__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__zh__TW__bodystringThe body of the article.
translated__content__zh__TW__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pt__BR__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pt__BR__titlestringThe title of the article.
translated__content__zh__CN__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__zh__CN__titlestringThe title of the article.
translated__content__zh__TW__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__zh__TW__titlestringThe title of the article.
translated__content__ar__author__idintegerThe ID of the author of the article.
translated__content__bg__author__idintegerThe ID of the author of the article.
translated__content__bs__author__idintegerThe ID of the author of the article.
translated__content__ca__author__idintegerThe ID of the author of the article.
translated__content__cs__author__idintegerThe ID of the author of the article.
translated__content__da__author__idintegerThe ID of the author of the article.
translated__content__de__author__idintegerThe ID of the author of the article.
translated__content__el__author__idintegerThe ID of the author of the article.
translated__content__en__author__idintegerThe ID of the author of the article.
translated__content__es__author__idintegerThe ID of the author of the article.
translated__content__et__author__idintegerThe ID of the author of the article.
translated__content__fi__author__idintegerThe ID of the author of the article.
translated__content__fr__author__idintegerThe ID of the author of the article.
translated__content__he__author__idintegerThe ID of the author of the article.
translated__content__hr__author__idintegerThe ID of the author of the article.
translated__content__hu__author__idintegerThe ID of the author of the article.
translated__content__id__author__idintegerThe ID of the author of the article.
translated__content__it__author__idintegerThe ID of the author of the article.
translated__content__ja__author__idintegerThe ID of the author of the article.
translated__content__ko__author__idintegerThe ID of the author of the article.
translated__content__lt__author__idintegerThe ID of the author of the article.
translated__content__lv__author__idintegerThe ID of the author of the article.
translated__content__mn__author__idintegerThe ID of the author of the article.
translated__content__nb__author__idintegerThe ID of the author of the article.
translated__content__nl__author__idintegerThe ID of the author of the article.
translated__content__pl__author__idintegerThe ID of the author of the article.
translated__content__pt__author__idintegerThe ID of the author of the article.
translated__content__ro__author__idintegerThe ID of the author of the article.
translated__content__ru__author__idintegerThe ID of the author of the article.
translated__content__sl__author__idintegerThe ID of the author of the article.
translated__content__sr__author__idintegerThe ID of the author of the article.
translated__content__sv__author__idintegerThe ID of the author of the article.
translated__content__tr__author__idintegerThe ID of the author of the article.
translated__content__vi__author__idintegerThe ID of the author of the article.
translated__content__ar__created__atintegerThe time when the article was created (seconds).
translated__content__ar__descriptionstringThe description of the article.
translated__content__ar__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bg__created__atintegerThe time when the article was created (seconds).
translated__content__bg__descriptionstringThe description of the article.
translated__content__bg__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bs__created__atintegerThe time when the article was created (seconds).
translated__content__bs__descriptionstringThe description of the article.
translated__content__bs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ca__created__atintegerThe time when the article was created (seconds).
translated__content__ca__descriptionstringThe description of the article.
translated__content__ca__updated__atintegerThe time when the article was last updated (seconds).
translated__content__cs__created__atintegerThe time when the article was created (seconds).
translated__content__cs__descriptionstringThe description of the article.
translated__content__cs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__da__created__atintegerThe time when the article was created (seconds).
translated__content__da__descriptionstringThe description of the article.
translated__content__da__updated__atintegerThe time when the article was last updated (seconds).
translated__content__de__created__atintegerThe time when the article was created (seconds).
translated__content__de__descriptionstringThe description of the article.
translated__content__de__updated__atintegerThe time when the article was last updated (seconds).
translated__content__el__created__atintegerThe time when the article was created (seconds).
translated__content__el__descriptionstringThe description of the article.
translated__content__el__updated__atintegerThe time when the article was last updated (seconds).
translated__content__en__created__atintegerThe time when the article was created (seconds).
translated__content__en__descriptionstringThe description of the article.
translated__content__en__updated__atintegerThe time when the article was last updated (seconds).
translated__content__es__created__atintegerThe time when the article was created (seconds).
translated__content__es__descriptionstringThe description of the article.
translated__content__es__updated__atintegerThe time when the article was last updated (seconds).
translated__content__et__created__atintegerThe time when the article was created (seconds).
translated__content__et__descriptionstringThe description of the article.
translated__content__et__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fi__created__atintegerThe time when the article was created (seconds).
translated__content__fi__descriptionstringThe description of the article.
translated__content__fi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fr__created__atintegerThe time when the article was created (seconds).
translated__content__fr__descriptionstringThe description of the article.
translated__content__fr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__he__created__atintegerThe time when the article was created (seconds).
translated__content__he__descriptionstringThe description of the article.
translated__content__he__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hr__created__atintegerThe time when the article was created (seconds).
translated__content__hr__descriptionstringThe description of the article.
translated__content__hr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hu__created__atintegerThe time when the article was created (seconds).
translated__content__hu__descriptionstringThe description of the article.
translated__content__hu__updated__atintegerThe time when the article was last updated (seconds).
translated__content__id__created__atintegerThe time when the article was created (seconds).
translated__content__id__descriptionstringThe description of the article.
translated__content__id__updated__atintegerThe time when the article was last updated (seconds).
translated__content__it__created__atintegerThe time when the article was created (seconds).
translated__content__it__descriptionstringThe description of the article.
translated__content__it__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ja__created__atintegerThe time when the article was created (seconds).
translated__content__ja__descriptionstringThe description of the article.
translated__content__ja__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ko__created__atintegerThe time when the article was created (seconds).
translated__content__ko__descriptionstringThe description of the article.
translated__content__ko__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lt__created__atintegerThe time when the article was created (seconds).
translated__content__lt__descriptionstringThe description of the article.
translated__content__lt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lv__created__atintegerThe time when the article was created (seconds).
translated__content__lv__descriptionstringThe description of the article.
translated__content__lv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__mn__created__atintegerThe time when the article was created (seconds).
translated__content__mn__descriptionstringThe description of the article.
translated__content__mn__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nb__created__atintegerThe time when the article was created (seconds).
translated__content__nb__descriptionstringThe description of the article.
translated__content__nb__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nl__created__atintegerThe time when the article was created (seconds).
translated__content__nl__descriptionstringThe description of the article.
translated__content__nl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pl__created__atintegerThe time when the article was created (seconds).
translated__content__pl__descriptionstringThe description of the article.
translated__content__pl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__created__atintegerThe time when the article was created (seconds).
translated__content__pt__descriptionstringThe description of the article.
translated__content__pt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ro__created__atintegerThe time when the article was created (seconds).
translated__content__ro__descriptionstringThe description of the article.
translated__content__ro__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ru__created__atintegerThe time when the article was created (seconds).
translated__content__ru__descriptionstringThe description of the article.
translated__content__ru__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sl__created__atintegerThe time when the article was created (seconds).
translated__content__sl__descriptionstringThe description of the article.
translated__content__sl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sr__created__atintegerThe time when the article was created (seconds).
translated__content__sr__descriptionstringThe description of the article.
translated__content__sr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sv__created__atintegerThe time when the article was created (seconds).
translated__content__sv__descriptionstringThe description of the article.
translated__content__sv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__tr__created__atintegerThe time when the article was created (seconds).
translated__content__tr__descriptionstringThe description of the article.
translated__content__tr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__vi__created__atintegerThe time when the article was created (seconds).
translated__content__vi__descriptionstringThe description of the article.
translated__content__vi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__BR__author__idintegerThe ID of the author of the article.
translated__content__zh__CN__author__idintegerThe ID of the author of the article.
translated__content__zh__TW__author__idintegerThe ID of the author of the article.
translated__content__pt__BR__created__atintegerThe time when the article was created (seconds).
translated__content__pt__BR__descriptionstringThe description of the article.
translated__content__pt__BR__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__CN__created__atintegerThe time when the article was created (seconds).
translated__content__zh__CN__descriptionstringThe description of the article.
translated__content__zh__CN__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__TW__created__atintegerThe time when the article was created (seconds).
translated__content__zh__TW__descriptionstringThe description of the article.
translated__content__zh__TW__updated__atintegerThe time when the article was last updated (seconds).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create a noteINTERCOM_CREATE_A_NOTEAcciónYou can add a note to a single contact.
INTERCOM_CREATE_A_NOTEAcciónYou can add a note to a single contact.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a given contact.
bodystringObligatorioThe text of the note.
admin_idstringThe unique identifier of a given admin.
contact_idstringThe unique identifier of a given contact.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create conversationINTERCOM_CREATE_CONVERSATIONAcciónCreates a new conversation in intercom
INTERCOM_CREATE_CONVERSATIONAcciónCreates a new conversation in intercom
Parámetros de entrada
bodystringObligatorioThe message content for the conversation
subjectstringSubject line for the conversation
from_user_idstringID of the user to create the conversation from. Either from_user_id or from_contact_id is required
message_typestringType of message: inapp, email, or facebook
from_admin_idstringID of the admin creating the conversation. If not provided, uses authenticated admin
from_contact_idstringID of the contact to create the conversation from. Either from_user_id or from_contact_id is required
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create or update a companyINTERCOM_CREATE_OR_UPDATE_A_COMPANYAcciónYou 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 %}
INTERCOM_CREATE_OR_UPDATE_A_COMPANYAcciónYou 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
namestringThe name of the Company
planstringThe name of the plan you have associated with the company.
sizeintegerThe number of employees in this company.
websitestringThe URL for this company"s website. Please note that the value specified here is not validated. Accepts any string.
industrystringThe industry that this company operates in.
company_idstringThe company id you have defined for the company. Can"t be updated
monthly_spendintegerHow 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_attributesobjectA hash of key/value pairs containing any other data about the company you want Intercom to store.
remote_created_atintegerThe time the company was created by you.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete a collectionINTERCOM_DELETE_A_COLLECTIONAcciónYou can delete a single collection by making a delete request to `https://api.intercom.io/collections/<id>`.
INTERCOM_DELETE_A_COLLECTIONAcciónYou can delete a single collection by making a delete request to `https://api.intercom.io/collections/<id>`.
Parámetros de entrada
idintegerObligatorioThe unique identifier for the collection which is given by Intercom.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete a companyINTERCOM_DELETE_A_COMPANYAcciónYou can delete a single company.
INTERCOM_DELETE_A_COMPANYAcciónYou can delete a single company.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete a contactINTERCOM_DELETE_A_CONTACTAcciónYou can delete a single contact.
INTERCOM_DELETE_A_CONTACTAcciónYou can delete a single contact.
Parámetros de entrada
idstringObligatorioid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete an articleINTERCOM_DELETE_AN_ARTICLEAcciónYou can delete a single article by making a delete request to `https://api.intercom.io/articles/<id>`.
INTERCOM_DELETE_AN_ARTICLEAcciónYou can delete a single article by making a delete request to `https://api.intercom.io/articles/<id>`.
Parámetros de entrada
idintegerObligatorioThe unique identifier for the article which is given by Intercom.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Detach a contact from a companyINTERCOM_DETACH_A_CONTACT_FROM_A_COMPANYAcciónYou can detach a company from a single contact.
INTERCOM_DETACH_A_CONTACT_FROM_A_COMPANYAcciónYou can detach a company from a single contact.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get a contactINTERCOM_GET_A_CONTACTAcciónYou can fetch the details of a single contact.
INTERCOM_GET_A_CONTACTAcciónYou can fetch the details of a single contact.
Parámetros de entrada
idstringObligatorioid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get conversationINTERCOM_GET_CONVERSATIONAcciónRetrieves a specific conversation by id with all messages and details
INTERCOM_GET_CONVERSATIONAcciónRetrieves a specific conversation by id with all messages and details
Parámetros de entrada
display_asstringDisplay format for message content: plaintext or html
conversation_idstringObligatorioThe ID of the conversation to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Identify an adminINTERCOM_IDENTIFY_AN_ADMINAcciónYou 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.
INTERCOM_IDENTIFY_AN_ADMINAcciónYou 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
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all activity logsINTERCOM_LIST_ALL_ACTIVITY_LOGSAcciónYou can get a log of activities by all admins in an app.
INTERCOM_LIST_ALL_ACTIVITY_LOGSAcciónYou can get a log of activities by all admins in an app.
Parámetros de entrada
created_at_afterstringObligatorioThe start date that you request data for. It must be formatted as a UNIX timestamp.
created_at_beforestringThe end date that you request data for. It must be formatted as a UNIX timestamp.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all adminsINTERCOM_LIST_ALL_ADMINSAcciónYou can fetch a list of admins for a given workspace.
INTERCOM_LIST_ALL_ADMINSAcciónYou can fetch a list of admins for a given workspace.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all articlesINTERCOM_LIST_ALL_ARTICLESAcciónYou 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.
INTERCOM_LIST_ALL_ARTICLESAcciónYou 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
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all collectionsINTERCOM_LIST_ALL_COLLECTIONSAcciónYou 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.
INTERCOM_LIST_ALL_COLLECTIONSAcciónYou 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
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all companiesINTERCOM_LIST_ALL_COMPANIESAcciónYou 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 %}
INTERCOM_LIST_ALL_COMPANIESAcciónYou 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
pageintegerThe 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_pageintegerHow many results to return per page. Defaults to 15
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all help centersINTERCOM_LIST_ALL_HELP_CENTERSAcciónYou can list all help centers by making a get request to `https://api.intercom.io/help center/help centers`.
INTERCOM_LIST_ALL_HELP_CENTERSAcciónYou 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
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List all notesINTERCOM_LIST_ALL_NOTESAcciónYou can fetch a list of notes that are associated to a contact.
INTERCOM_LIST_ALL_NOTESAcciónYou can fetch a list of notes that are associated to a contact.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a contact.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List attached companies for contactINTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACTAcciónYou can fetch a list of companies that are associated to a contact.
INTERCOM_LIST_ATTACHED_COMPANIES_FOR_CONTACTAcciónYou can fetch a list of companies that are associated to a contact.
Parámetros de entrada
idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List attached contactsINTERCOM_LIST_ATTACHED_CONTACTSAcciónYou can fetch a list of all contacts that belong to a company.
INTERCOM_LIST_ATTACHED_CONTACTSAcciónYou can fetch a list of all contacts that belong to a company.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List attached segments for companiesINTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIESAcciónYou can fetch a list of all segments that belong to a company.
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_COMPANIESAcciónYou can fetch a list of all segments that belong to a company.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List attached segments for contactINTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACTAcciónYou can fetch a list of segments that are associated to a contact.
INTERCOM_LIST_ATTACHED_SEGMENTS_FOR_CONTACTAcciónYou can fetch a list of segments that are associated to a contact.
Parámetros de entrada
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List conversationsINTERCOM_LIST_CONVERSATIONSAcciónLists conversations from intercom with filtering and pagination support
INTERCOM_LIST_CONVERSATIONSAcciónLists conversations from intercom with filtering and pagination support
Parámetros de entrada
statestringFilter by conversation state: open, closed, snoozed
per_pageintegerNumber of conversations per page (1-150)
display_asstringDisplay format: plaintext or html
assignee_idstringFilter by assignee admin ID
starting_afterstringPagination cursor - ID of the last conversation from previous page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List subscriptions for a contactINTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACTAcciónYou 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.
INTERCOM_LIST_SUBSCRIPTIONS_FOR_A_CONTACTAcciónYou 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_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List tags attached to a contactINTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACTAcciónYou can fetch a list of all tags that are attached to a specific contact.
INTERCOM_LIST_TAGS_ATTACHED_TO_A_CONTACTAcciónYou can fetch a list of all tags that are attached to a specific contact.
Parámetros de entrada
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Merge a lead and a userINTERCOM_MERGE_A_LEAD_AND_A_USERAcciónYou can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.
INTERCOM_MERGE_A_LEAD_AND_A_USERAcciónYou can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.
Parámetros de entrada
fromstringThe unique identifier for the contact to merge away from. Must be a lead.
intostringThe unique identifier for the contact to merge into. Must be a user.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove subscription from a contactINTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACTAcciónYou 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.
INTERCOM_REMOVE_SUBSCRIPTION_FROM_A_CONTACTAcciónYou 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
idstringObligatorioThe unique identifier for the subscription type which is given by Intercom
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove tag from a contactINTERCOM_REMOVE_TAG_FROM_A_CONTACTAcciónYou can remove tag from a specific contact. this will return a tag object for the tag that was removed from the contact.
INTERCOM_REMOVE_TAG_FROM_A_CONTACTAcciónYou 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
idstringObligatorioThe unique identifier for the tag which is given by Intercom
contact_idstringObligatorioThe unique identifier for the contact which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reopen conversationINTERCOM_REOPEN_CONVERSATIONAcciónReopens a closed conversation in intercom
INTERCOM_REOPEN_CONVERSATIONAcciónReopens a closed conversation in intercom
Parámetros de entrada
bodystringOptional message to send when reopening the conversation
admin_idstringObligatorioID of the admin reopening the conversation
conversation_idstringObligatorioThe ID of the conversation to reopen
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reply to conversationINTERCOM_REPLY_TO_CONVERSATIONAcciónSends a reply to an existing conversation in intercom
INTERCOM_REPLY_TO_CONVERSATIONAcciónSends a reply to an existing conversation in intercom
Parámetros de entrada
admin_idstringID of the admin sending the reply. If not provided, uses the authenticated admin
message_bodystringObligatorioThe message content to send as a reply
message_typestringType of message: comment, note, or assignment
attachment_urlsstring[]List of attachment URLs to include in the reply
conversation_idstringObligatorioThe ID of the conversation to reply to
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a collectionINTERCOM_RETRIEVE_A_COLLECTIONAcciónYou can fetch the details of a single collection by making a get request to `https://api.intercom.io/help center/collections/<id>`.
INTERCOM_RETRIEVE_A_COLLECTIONAcciónYou 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
idintegerObligatorioThe unique identifier for the collection which is given by Intercom.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a company by idINTERCOM_RETRIEVE_A_COMPANY_BY_IDAcciónYou can fetch a single company.
INTERCOM_RETRIEVE_A_COMPANY_BY_IDAcciónYou can fetch a single company.
Parámetros de entrada
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve a help centerINTERCOM_RETRIEVE_A_HELP_CENTERAcciónYou can fetch the details of a single help center by making a get request to `https://api.intercom.io/help center/help center/<id>`.
INTERCOM_RETRIEVE_A_HELP_CENTERAcciónYou 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
idintegerObligatorioThe unique identifier for the collection which is given by Intercom.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an adminINTERCOM_RETRIEVE_AN_ADMINAcciónYou can retrieve the details of a single admin.
INTERCOM_RETRIEVE_AN_ADMINAcciónYou can retrieve the details of a single admin.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a given admin
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve an articleINTERCOM_RETRIEVE_AN_ARTICLEAcciónYou can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/<id>`.
INTERCOM_RETRIEVE_AN_ARTICLEAcciónYou can fetch the details of a single article by making a get request to `https://api.intercom.io/articles/<id>`.
Parámetros de entrada
idintegerObligatorioThe unique identifier for the article which is given by Intercom.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve companiesINTERCOM_RETRIEVE_COMPANIESAcciónYou 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}`
INTERCOM_RETRIEVE_COMPANIESAcciónYou 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
namestringThe `name` of the company to filter by.
pageintegerThe page of results to fetch. Defaults to first page
tag_idstringThe `tag_id` of the company to filter by.
per_pageintegerHow many results to display per page. Defaults to 15
company_idstringThe `company_id` of the company to filter by.
segment_idstringThe `segment_id` of the company to filter by.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Scroll over all companiesINTERCOM_SCROLL_OVER_ALL_COMPANIESAcciónThe `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.
INTERCOM_SCROLL_OVER_ALL_COMPANIESAcciónThe `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_paramstringScroll Param
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search conversationsINTERCOM_SEARCH_CONVERSATIONSAcciónSearches for conversations using query string with support for filtering and sorting
INTERCOM_SEARCH_CONVERSATIONSAcciónSearches for conversations using query string with support for filtering and sorting
Parámetros de entrada
querystringObligatorioSearch query string to find conversations
per_pageintegerNumber of conversations per page (1-150)
sort_fieldstringField to sort by: created_at, updated_at, waiting_since
sort_orderstringSort order: ascending or descending
starting_afterstringPagination cursor - ID of the last conversation from previous page
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search for articlesINTERCOM_SEARCH_FOR_ARTICLESAcciónYou can search for articles by making a get request to `https://api.intercom.io/articles/search`.
INTERCOM_SEARCH_FOR_ARTICLESAcciónYou can search for articles by making a get request to `https://api.intercom.io/articles/search`.
Parámetros de entrada
statestringThe state of the Articles returned. One of `published`, `draft` or `all`.
phrasestringThe phrase within your articles to search for.
highlightbooleanReturn a highlighted version of the matching content within your articles. Refer to the response schema for more details.
help_center_idintegerThe ID of the Help Center to search in.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set an admin to awayINTERCOM_SET_AN_ADMIN_TO_AWAYAcciónYou can set an admin as away for the inbox.
INTERCOM_SET_AN_ADMIN_TO_AWAYAcciónYou can set an admin as away for the inbox.
Parámetros de entrada
idintegerObligatorioThe unique identifier of a given admin
away_mode_enabledbooleanSet to "true" to change the status of the admin to away.
away_mode_reassignbooleanSet to "true" to assign any new conversation replies to your default inbox.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update a collectionINTERCOM_UPDATE_A_COLLECTIONAcciónYou can update the details of a single collection by making a put request to `https://api.intercom.io/collections/<id>`.
INTERCOM_UPDATE_A_COLLECTIONAcciónYou can update the details of a single collection by making a put request to `https://api.intercom.io/collections/<id>`.
Parámetros de entrada
idintegerObligatorioThe unique identifier for the collection which is given by Intercom.
namestringThe name of the collection. For multilingual collections, this will be the name of the default language"s content.
parent_idstringThe id of the parent collection. If `null` then it will be updated as the first level collection.
descriptionstringThe description of the collection. For multilingual collections, this will be the description of the default language"s content.
translated__content__typestringenumThe type of object - group_translated_content.
Nonegroup_translated_contenttranslated__content__ar__namestringThe name of the collection or section.
translated__content__ar__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__bg__namestringThe name of the collection or section.
translated__content__bg__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__bs__namestringThe name of the collection or section.
translated__content__bs__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ca__namestringThe name of the collection or section.
translated__content__ca__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__cs__namestringThe name of the collection or section.
translated__content__cs__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__da__namestringThe name of the collection or section.
translated__content__da__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__de__namestringThe name of the collection or section.
translated__content__de__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__el__namestringThe name of the collection or section.
translated__content__el__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__en__namestringThe name of the collection or section.
translated__content__en__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__es__namestringThe name of the collection or section.
translated__content__es__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__et__namestringThe name of the collection or section.
translated__content__et__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__fi__namestringThe name of the collection or section.
translated__content__fi__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__fr__namestringThe name of the collection or section.
translated__content__fr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__he__namestringThe name of the collection or section.
translated__content__he__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__hr__namestringThe name of the collection or section.
translated__content__hr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__hu__namestringThe name of the collection or section.
translated__content__hu__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__id__namestringThe name of the collection or section.
translated__content__id__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__it__namestringThe name of the collection or section.
translated__content__it__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ja__namestringThe name of the collection or section.
translated__content__ja__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ko__namestringThe name of the collection or section.
translated__content__ko__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__lt__namestringThe name of the collection or section.
translated__content__lt__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__lv__namestringThe name of the collection or section.
translated__content__lv__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__mn__namestringThe name of the collection or section.
translated__content__mn__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__nb__namestringThe name of the collection or section.
translated__content__nb__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__nl__namestringThe name of the collection or section.
translated__content__nl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pl__namestringThe name of the collection or section.
translated__content__pl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pt__namestringThe name of the collection or section.
translated__content__pt__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ro__namestringThe name of the collection or section.
translated__content__ro__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ru__namestringThe name of the collection or section.
translated__content__ru__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sl__namestringThe name of the collection or section.
translated__content__sl__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sr__namestringThe name of the collection or section.
translated__content__sr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__sv__namestringThe name of the collection or section.
translated__content__sv__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__tr__namestringThe name of the collection or section.
translated__content__tr__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__vi__namestringThe name of the collection or section.
translated__content__vi__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__pt__BR__namestringThe name of the collection or section.
translated__content__pt__BR__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__zh__CN__namestringThe name of the collection or section.
translated__content__zh__CN__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__zh__TW__namestringThe name of the collection or section.
translated__content__zh__TW__typestringenumThe type of object - `group_content` .
Nonegroup_contenttranslated__content__ar__descriptionstringThe description of the collection. Only available for collections.
translated__content__bg__descriptionstringThe description of the collection. Only available for collections.
translated__content__bs__descriptionstringThe description of the collection. Only available for collections.
translated__content__ca__descriptionstringThe description of the collection. Only available for collections.
translated__content__cs__descriptionstringThe description of the collection. Only available for collections.
translated__content__da__descriptionstringThe description of the collection. Only available for collections.
translated__content__de__descriptionstringThe description of the collection. Only available for collections.
translated__content__el__descriptionstringThe description of the collection. Only available for collections.
translated__content__en__descriptionstringThe description of the collection. Only available for collections.
translated__content__es__descriptionstringThe description of the collection. Only available for collections.
translated__content__et__descriptionstringThe description of the collection. Only available for collections.
translated__content__fi__descriptionstringThe description of the collection. Only available for collections.
translated__content__fr__descriptionstringThe description of the collection. Only available for collections.
translated__content__he__descriptionstringThe description of the collection. Only available for collections.
translated__content__hr__descriptionstringThe description of the collection. Only available for collections.
translated__content__hu__descriptionstringThe description of the collection. Only available for collections.
translated__content__id__descriptionstringThe description of the collection. Only available for collections.
translated__content__it__descriptionstringThe description of the collection. Only available for collections.
translated__content__ja__descriptionstringThe description of the collection. Only available for collections.
translated__content__ko__descriptionstringThe description of the collection. Only available for collections.
translated__content__lt__descriptionstringThe description of the collection. Only available for collections.
translated__content__lv__descriptionstringThe description of the collection. Only available for collections.
translated__content__mn__descriptionstringThe description of the collection. Only available for collections.
translated__content__nb__descriptionstringThe description of the collection. Only available for collections.
translated__content__nl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pl__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__descriptionstringThe description of the collection. Only available for collections.
translated__content__ro__descriptionstringThe description of the collection. Only available for collections.
translated__content__ru__descriptionstringThe description of the collection. Only available for collections.
translated__content__sl__descriptionstringThe description of the collection. Only available for collections.
translated__content__sr__descriptionstringThe description of the collection. Only available for collections.
translated__content__sv__descriptionstringThe description of the collection. Only available for collections.
translated__content__tr__descriptionstringThe description of the collection. Only available for collections.
translated__content__vi__descriptionstringThe description of the collection. Only available for collections.
translated__content__pt__BR__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__CN__descriptionstringThe description of the collection. Only available for collections.
translated__content__zh__TW__descriptionstringThe description of the collection. Only available for collections.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update a companyINTERCOM_UPDATE_A_COMPANYAcciónYou 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 %}
INTERCOM_UPDATE_A_COMPANYAcciónYou 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
idstringObligatorioThe unique identifier for the company which is given by Intercom
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update a contactINTERCOM_UPDATE_A_CONTACTAcciónYou can update an existing contact (ie. user or lead).
INTERCOM_UPDATE_A_CONTACTAcciónYou can update an existing contact (ie. user or lead).
Parámetros de entrada
idstringObligatorioid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update an articleINTERCOM_UPDATE_AN_ARTICLEAcciónYou can update the details of a single article by making a put request to `https://api.intercom.io/articles/<id>`.
INTERCOM_UPDATE_AN_ARTICLEAcciónYou can update the details of a single article by making a put request to `https://api.intercom.io/articles/<id>`.
Parámetros de entrada
idintegerObligatorioThe unique identifier for the article which is given by Intercom.
bodystringThe content of the article. For multilingual articles, this will be the body of the default language"s content.
statestringenumWhether 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.
publisheddrafttitlestringThe title of the article.For multilingual articles, this will be the title of the default language"s content.
author_idintegerThe 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_idstringThe id of the article"s parent collection or section. An article without this field stands alone.
descriptionstringThe description of the article. For multilingual articles, this will be the description of the default language"s content.
parent_typestringThe type of parent, which can either be a `collection` or `section`.
translated__content__typestringenumThe type of object - article_translated_content.
Nonearticle_translated_contenttranslated__content__ar__urlstringThe URL of the article.
translated__content__bg__urlstringThe URL of the article.
translated__content__bs__urlstringThe URL of the article.
translated__content__ca__urlstringThe URL of the article.
translated__content__cs__urlstringThe URL of the article.
translated__content__da__urlstringThe URL of the article.
translated__content__de__urlstringThe URL of the article.
translated__content__el__urlstringThe URL of the article.
translated__content__en__urlstringThe URL of the article.
translated__content__es__urlstringThe URL of the article.
translated__content__et__urlstringThe URL of the article.
translated__content__fi__urlstringThe URL of the article.
translated__content__fr__urlstringThe URL of the article.
translated__content__he__urlstringThe URL of the article.
translated__content__hr__urlstringThe URL of the article.
translated__content__hu__urlstringThe URL of the article.
translated__content__id__urlstringThe URL of the article.
translated__content__it__urlstringThe URL of the article.
translated__content__ja__urlstringThe URL of the article.
translated__content__ko__urlstringThe URL of the article.
translated__content__lt__urlstringThe URL of the article.
translated__content__lv__urlstringThe URL of the article.
translated__content__mn__urlstringThe URL of the article.
translated__content__nb__urlstringThe URL of the article.
translated__content__nl__urlstringThe URL of the article.
translated__content__pl__urlstringThe URL of the article.
translated__content__pt__urlstringThe URL of the article.
translated__content__ro__urlstringThe URL of the article.
translated__content__ru__urlstringThe URL of the article.
translated__content__sl__urlstringThe URL of the article.
translated__content__sr__urlstringThe URL of the article.
translated__content__sv__urlstringThe URL of the article.
translated__content__tr__urlstringThe URL of the article.
translated__content__vi__urlstringThe URL of the article.
translated__content__ar__bodystringThe body of the article.
translated__content__ar__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__bg__bodystringThe body of the article.
translated__content__bg__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__bs__bodystringThe body of the article.
translated__content__bs__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ca__bodystringThe body of the article.
translated__content__ca__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__cs__bodystringThe body of the article.
translated__content__cs__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__da__bodystringThe body of the article.
translated__content__da__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__de__bodystringThe body of the article.
translated__content__de__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__el__bodystringThe body of the article.
translated__content__el__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__en__bodystringThe body of the article.
translated__content__en__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__es__bodystringThe body of the article.
translated__content__es__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__et__bodystringThe body of the article.
translated__content__et__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__fi__bodystringThe body of the article.
translated__content__fi__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__fr__bodystringThe body of the article.
translated__content__fr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__he__bodystringThe body of the article.
translated__content__he__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__hr__bodystringThe body of the article.
translated__content__hr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__hu__bodystringThe body of the article.
translated__content__hu__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__id__bodystringThe body of the article.
translated__content__id__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__it__bodystringThe body of the article.
translated__content__it__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ja__bodystringThe body of the article.
translated__content__ja__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ko__bodystringThe body of the article.
translated__content__ko__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__lt__bodystringThe body of the article.
translated__content__lt__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__lv__bodystringThe body of the article.
translated__content__lv__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__mn__bodystringThe body of the article.
translated__content__mn__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__nb__bodystringThe body of the article.
translated__content__nb__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__nl__bodystringThe body of the article.
translated__content__nl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pl__bodystringThe body of the article.
translated__content__pl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pt__bodystringThe body of the article.
translated__content__pt__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ro__bodystringThe body of the article.
translated__content__ro__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ru__bodystringThe body of the article.
translated__content__ru__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sl__bodystringThe body of the article.
translated__content__sl__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sr__bodystringThe body of the article.
translated__content__sr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__sv__bodystringThe body of the article.
translated__content__sv__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__tr__bodystringThe body of the article.
translated__content__tr__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__vi__bodystringThe body of the article.
translated__content__vi__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__ar__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ar__titlestringThe title of the article.
translated__content__bg__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__bg__titlestringThe title of the article.
translated__content__bs__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__bs__titlestringThe title of the article.
translated__content__ca__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ca__titlestringThe title of the article.
translated__content__cs__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__cs__titlestringThe title of the article.
translated__content__da__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__da__titlestringThe title of the article.
translated__content__de__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__de__titlestringThe title of the article.
translated__content__el__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__el__titlestringThe title of the article.
translated__content__en__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__en__titlestringThe title of the article.
translated__content__es__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__es__titlestringThe title of the article.
translated__content__et__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__et__titlestringThe title of the article.
translated__content__fi__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__fi__titlestringThe title of the article.
translated__content__fr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__fr__titlestringThe title of the article.
translated__content__he__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__he__titlestringThe title of the article.
translated__content__hr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__hr__titlestringThe title of the article.
translated__content__hu__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__hu__titlestringThe title of the article.
translated__content__id__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__id__titlestringThe title of the article.
translated__content__it__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__it__titlestringThe title of the article.
translated__content__ja__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ja__titlestringThe title of the article.
translated__content__ko__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ko__titlestringThe title of the article.
translated__content__lt__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__lt__titlestringThe title of the article.
translated__content__lv__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__lv__titlestringThe title of the article.
translated__content__mn__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__mn__titlestringThe title of the article.
translated__content__nb__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__nb__titlestringThe title of the article.
translated__content__nl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__nl__titlestringThe title of the article.
translated__content__pl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pl__titlestringThe title of the article.
translated__content__pt__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pt__titlestringThe title of the article.
translated__content__ro__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ro__titlestringThe title of the article.
translated__content__ru__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__ru__titlestringThe title of the article.
translated__content__sl__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sl__titlestringThe title of the article.
translated__content__sr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sr__titlestringThe title of the article.
translated__content__sv__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__sv__titlestringThe title of the article.
translated__content__tr__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__tr__titlestringThe title of the article.
translated__content__vi__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__vi__titlestringThe title of the article.
translated__content__pt__BR__urlstringThe URL of the article.
translated__content__zh__CN__urlstringThe URL of the article.
translated__content__zh__TW__urlstringThe URL of the article.
translated__content__pt__BR__bodystringThe body of the article.
translated__content__pt__BR__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__zh__CN__bodystringThe body of the article.
translated__content__zh__CN__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__zh__TW__bodystringThe body of the article.
translated__content__zh__TW__typestringenumThe type of object - `article_content` .
Nonearticle_contenttranslated__content__pt__BR__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__pt__BR__titlestringThe title of the article.
translated__content__zh__CN__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__zh__CN__titlestringThe title of the article.
translated__content__zh__TW__statestringenumWhether the article is `published` or is a `draft` .
publisheddrafttranslated__content__zh__TW__titlestringThe title of the article.
translated__content__ar__author__idintegerThe ID of the author of the article.
translated__content__bg__author__idintegerThe ID of the author of the article.
translated__content__bs__author__idintegerThe ID of the author of the article.
translated__content__ca__author__idintegerThe ID of the author of the article.
translated__content__cs__author__idintegerThe ID of the author of the article.
translated__content__da__author__idintegerThe ID of the author of the article.
translated__content__de__author__idintegerThe ID of the author of the article.
translated__content__el__author__idintegerThe ID of the author of the article.
translated__content__en__author__idintegerThe ID of the author of the article.
translated__content__es__author__idintegerThe ID of the author of the article.
translated__content__et__author__idintegerThe ID of the author of the article.
translated__content__fi__author__idintegerThe ID of the author of the article.
translated__content__fr__author__idintegerThe ID of the author of the article.
translated__content__he__author__idintegerThe ID of the author of the article.
translated__content__hr__author__idintegerThe ID of the author of the article.
translated__content__hu__author__idintegerThe ID of the author of the article.
translated__content__id__author__idintegerThe ID of the author of the article.
translated__content__it__author__idintegerThe ID of the author of the article.
translated__content__ja__author__idintegerThe ID of the author of the article.
translated__content__ko__author__idintegerThe ID of the author of the article.
translated__content__lt__author__idintegerThe ID of the author of the article.
translated__content__lv__author__idintegerThe ID of the author of the article.
translated__content__mn__author__idintegerThe ID of the author of the article.
translated__content__nb__author__idintegerThe ID of the author of the article.
translated__content__nl__author__idintegerThe ID of the author of the article.
translated__content__pl__author__idintegerThe ID of the author of the article.
translated__content__pt__author__idintegerThe ID of the author of the article.
translated__content__ro__author__idintegerThe ID of the author of the article.
translated__content__ru__author__idintegerThe ID of the author of the article.
translated__content__sl__author__idintegerThe ID of the author of the article.
translated__content__sr__author__idintegerThe ID of the author of the article.
translated__content__sv__author__idintegerThe ID of the author of the article.
translated__content__tr__author__idintegerThe ID of the author of the article.
translated__content__vi__author__idintegerThe ID of the author of the article.
translated__content__ar__created__atintegerThe time when the article was created (seconds).
translated__content__ar__descriptionstringThe description of the article.
translated__content__ar__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bg__created__atintegerThe time when the article was created (seconds).
translated__content__bg__descriptionstringThe description of the article.
translated__content__bg__updated__atintegerThe time when the article was last updated (seconds).
translated__content__bs__created__atintegerThe time when the article was created (seconds).
translated__content__bs__descriptionstringThe description of the article.
translated__content__bs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ca__created__atintegerThe time when the article was created (seconds).
translated__content__ca__descriptionstringThe description of the article.
translated__content__ca__updated__atintegerThe time when the article was last updated (seconds).
translated__content__cs__created__atintegerThe time when the article was created (seconds).
translated__content__cs__descriptionstringThe description of the article.
translated__content__cs__updated__atintegerThe time when the article was last updated (seconds).
translated__content__da__created__atintegerThe time when the article was created (seconds).
translated__content__da__descriptionstringThe description of the article.
translated__content__da__updated__atintegerThe time when the article was last updated (seconds).
translated__content__de__created__atintegerThe time when the article was created (seconds).
translated__content__de__descriptionstringThe description of the article.
translated__content__de__updated__atintegerThe time when the article was last updated (seconds).
translated__content__el__created__atintegerThe time when the article was created (seconds).
translated__content__el__descriptionstringThe description of the article.
translated__content__el__updated__atintegerThe time when the article was last updated (seconds).
translated__content__en__created__atintegerThe time when the article was created (seconds).
translated__content__en__descriptionstringThe description of the article.
translated__content__en__updated__atintegerThe time when the article was last updated (seconds).
translated__content__es__created__atintegerThe time when the article was created (seconds).
translated__content__es__descriptionstringThe description of the article.
translated__content__es__updated__atintegerThe time when the article was last updated (seconds).
translated__content__et__created__atintegerThe time when the article was created (seconds).
translated__content__et__descriptionstringThe description of the article.
translated__content__et__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fi__created__atintegerThe time when the article was created (seconds).
translated__content__fi__descriptionstringThe description of the article.
translated__content__fi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__fr__created__atintegerThe time when the article was created (seconds).
translated__content__fr__descriptionstringThe description of the article.
translated__content__fr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__he__created__atintegerThe time when the article was created (seconds).
translated__content__he__descriptionstringThe description of the article.
translated__content__he__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hr__created__atintegerThe time when the article was created (seconds).
translated__content__hr__descriptionstringThe description of the article.
translated__content__hr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__hu__created__atintegerThe time when the article was created (seconds).
translated__content__hu__descriptionstringThe description of the article.
translated__content__hu__updated__atintegerThe time when the article was last updated (seconds).
translated__content__id__created__atintegerThe time when the article was created (seconds).
translated__content__id__descriptionstringThe description of the article.
translated__content__id__updated__atintegerThe time when the article was last updated (seconds).
translated__content__it__created__atintegerThe time when the article was created (seconds).
translated__content__it__descriptionstringThe description of the article.
translated__content__it__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ja__created__atintegerThe time when the article was created (seconds).
translated__content__ja__descriptionstringThe description of the article.
translated__content__ja__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ko__created__atintegerThe time when the article was created (seconds).
translated__content__ko__descriptionstringThe description of the article.
translated__content__ko__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lt__created__atintegerThe time when the article was created (seconds).
translated__content__lt__descriptionstringThe description of the article.
translated__content__lt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__lv__created__atintegerThe time when the article was created (seconds).
translated__content__lv__descriptionstringThe description of the article.
translated__content__lv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__mn__created__atintegerThe time when the article was created (seconds).
translated__content__mn__descriptionstringThe description of the article.
translated__content__mn__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nb__created__atintegerThe time when the article was created (seconds).
translated__content__nb__descriptionstringThe description of the article.
translated__content__nb__updated__atintegerThe time when the article was last updated (seconds).
translated__content__nl__created__atintegerThe time when the article was created (seconds).
translated__content__nl__descriptionstringThe description of the article.
translated__content__nl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pl__created__atintegerThe time when the article was created (seconds).
translated__content__pl__descriptionstringThe description of the article.
translated__content__pl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__created__atintegerThe time when the article was created (seconds).
translated__content__pt__descriptionstringThe description of the article.
translated__content__pt__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ro__created__atintegerThe time when the article was created (seconds).
translated__content__ro__descriptionstringThe description of the article.
translated__content__ro__updated__atintegerThe time when the article was last updated (seconds).
translated__content__ru__created__atintegerThe time when the article was created (seconds).
translated__content__ru__descriptionstringThe description of the article.
translated__content__ru__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sl__created__atintegerThe time when the article was created (seconds).
translated__content__sl__descriptionstringThe description of the article.
translated__content__sl__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sr__created__atintegerThe time when the article was created (seconds).
translated__content__sr__descriptionstringThe description of the article.
translated__content__sr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__sv__created__atintegerThe time when the article was created (seconds).
translated__content__sv__descriptionstringThe description of the article.
translated__content__sv__updated__atintegerThe time when the article was last updated (seconds).
translated__content__tr__created__atintegerThe time when the article was created (seconds).
translated__content__tr__descriptionstringThe description of the article.
translated__content__tr__updated__atintegerThe time when the article was last updated (seconds).
translated__content__vi__created__atintegerThe time when the article was created (seconds).
translated__content__vi__descriptionstringThe description of the article.
translated__content__vi__updated__atintegerThe time when the article was last updated (seconds).
translated__content__pt__BR__author__idintegerThe ID of the author of the article.
translated__content__zh__CN__author__idintegerThe ID of the author of the article.
translated__content__zh__TW__author__idintegerThe ID of the author of the article.
translated__content__pt__BR__created__atintegerThe time when the article was created (seconds).
translated__content__pt__BR__descriptionstringThe description of the article.
translated__content__pt__BR__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__CN__created__atintegerThe time when the article was created (seconds).
translated__content__zh__CN__descriptionstringThe description of the article.
translated__content__zh__CN__updated__atintegerThe time when the article was last updated (seconds).
translated__content__zh__TW__created__atintegerThe time when the article was created (seconds).
translated__content__zh__TW__descriptionstringThe description of the article.
translated__content__zh__TW__updated__atintegerThe time when the article was last updated (seconds).
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not