From e68d27e4f4fe9f570f0852ea9168a701192e896c Mon Sep 17 00:00:00 2001 From: Rahul D'Souza Date: Fri, 9 Oct 2026 17:17:58 +0100 Subject: [PATCH] Document the environment parameter on the Fin Agent API Co-Authored-By: Claude Opus 5.5 --- descriptions/0/api.intercom.io.yaml | 12 ++++++++++++ descriptions/2.14/api.intercom.io.yaml | 12 ++++++++++++ descriptions/2.15/api.intercom.io.yaml | 12 ++++++++++++ descriptions/2.16/api.intercom.io.yaml | 12 ++++++++++++ 4 files changed, 48 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 82a9f79c..871b1c29 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -27504,6 +27504,10 @@ paths: maxItems: 10 items: "$ref": "#/components/schemas/fin_agent_attachment" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -27886,6 +27890,10 @@ paths: additionalProperties: true example: order_id: '98765' + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - user @@ -28373,6 +28381,10 @@ paths: "$ref": "#/components/schemas/fin_agent_attachment" conversation_metadata: "$ref": "#/components/schemas/fin_agent_conversation_metadata" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index f1daeff7..50987d2e 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -1949,6 +1949,10 @@ paths: "$ref": "#/components/schemas/fin_agent_attachment" conversation_metadata: "$ref": "#/components/schemas/fin_agent_conversation_metadata" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -2607,6 +2611,10 @@ paths: maxItems: 10 items: "$ref": "#/components/schemas/fin_agent_attachment" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -2826,6 +2834,10 @@ paths: additionalProperties: true example: order_id: '98765' + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - user diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index 201a05f8..3c59063a 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -1955,6 +1955,10 @@ paths: "$ref": "#/components/schemas/fin_agent_attachment" conversation_metadata: "$ref": "#/components/schemas/fin_agent_conversation_metadata" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -15401,6 +15405,10 @@ paths: maxItems: 10 items: "$ref": "#/components/schemas/fin_agent_attachment" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -15620,6 +15628,10 @@ paths: additionalProperties: true example: order_id: '98765' + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - user diff --git a/descriptions/2.16/api.intercom.io.yaml b/descriptions/2.16/api.intercom.io.yaml index c14dbb34..acf88e8d 100644 --- a/descriptions/2.16/api.intercom.io.yaml +++ b/descriptions/2.16/api.intercom.io.yaml @@ -4112,6 +4112,10 @@ paths: "$ref": "#/components/schemas/fin_agent_attachment" conversation_metadata: "$ref": "#/components/schemas/fin_agent_conversation_metadata" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -4771,6 +4775,10 @@ paths: maxItems: 10 items: "$ref": "#/components/schemas/fin_agent_attachment" + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - message @@ -4990,6 +4998,10 @@ paths: additionalProperties: true example: order_id: '98765' + environment: + type: string + description: The identifier of the environment to start the conversation in, if your Fin for Platforms workspace has environments. Use the same value as `messenger_environment` in your Messenger installation. Defaults to the workspace's default environment; an identifier that matches no environment is rejected. + example: a1b2c3d4e5 required: - conversation_id - user