diff --git a/.spelling b/.spelling index c84505b9..1e693202 100644 --- a/.spelling +++ b/.spelling @@ -58,4 +58,5 @@ period uri url dropdown -special \ No newline at end of file +special +org \ No newline at end of file diff --git a/content/schemas/integration_mapping_partner_item_slack.yml b/content/schemas/integration_mapping_partner_item_slack.yml index 09ffeee9..3ae20839 100644 --- a/content/schemas/integration_mapping_partner_item_slack.yml +++ b/content/schemas/integration_mapping_partner_item_slack.yml @@ -4,7 +4,11 @@ title: Integration mapping mapped item schema for type Slack type: object description: |- - The schema for an integration mapping mapped item object for type Slack + The schema for an integration mapping mapped item object for type Slack. + + Depending if Box for Slack is installed at the org or workspace level, + provide **either** `slack_org_id` **or** `slack_workspace_id`. + Do not use both parameters at the same time. properties: type: @@ -21,12 +25,16 @@ properties: slack_workspace_id: type: string example: 'T12352314' - description: ID of the Slack workspace with which the item is associated + description: ID of the Slack workspace with which the item is associated. + Use this parameter if Box for Slack is installed at a workspace level. + Do not use `slack_org_id` at the same time. nullable: true slack_org_id: type: string example: 'E1234567' - description: ID of the Slack organization with which the item is associated + description: ID of the Slack org with which the item is associated. + Use this parameter if Box for Slack is installed at the org level. + Do not use `slack_workspace_id` at the same time. nullable: true required: