{
  "name": "ShareMiroBoard",
  "fully_qualified_name": "MiroApi.ShareMiroBoard@2.0.0",
  "description": "Invite new members to collaborate on a Miro board.\n\nUse this tool to share a Miro board by sending invitation emails to new collaborators. Membership in the team might be required based on the board's sharing policy.",
  "toolkit": {
    "name": "ArcadeMiroApi",
    "description": null,
    "version": "2.0.0"
  },
  "input": {
    "parameters": [
      {
        "name": "board_unique_identifier",
        "required": true,
        "description": "Unique identifier for the Miro board you want to share. Required to specify the target board.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier (ID) of the board to which the board member belongs."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "board_id"
      },
      {
        "name": "invitee_email_addresses",
        "required": true,
        "description": "A list of up to 20 email addresses to invite to the board.",
        "value_schema": {
          "val_type": "array",
          "inner_val_type": "string",
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Email IDs of the users you want to invite to the board. You can invite up to 20 members per call."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "emails"
      },
      {
        "name": "board_member_role",
        "required": false,
        "description": "Role assigned to the board member. Options are viewer, commenter, editor, coowner, or owner. Note: 'owner' functions as 'coowner'.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "viewer",
            "commenter",
            "editor",
            "coowner",
            "owner"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Role of the board member. Inviting users with the role `owner` has the same effect as the role `coowner`."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "role"
      },
      {
        "name": "invitation_message",
        "required": false,
        "description": "A custom message to include in the invitation email sent to new board collaborators.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The message that will be sent in the invitation email."
        },
        "inferrable": true,
        "http_endpoint_parameter_name": "message"
      }
    ]
  },
  "output": {
    "description": "Response from the API endpoint 'share-board'.",
    "available_modes": [
      "value",
      "error",
      "null"
    ],
    "value_schema": {
      "val_type": "json",
      "inner_val_type": null,
      "enum": null,
      "properties": null,
      "inner_properties": null,
      "description": null
    }
  },
  "requirements": {
    "authorization": {
      "provider_id": "arcade-miro",
      "provider_type": "oauth2",
      "id": null,
      "oauth2": null
    },
    "secrets": null,
    "metadata": null
  },
  "deprecation_message": null,
  "metadata": {
    "object_type": "api_wrapper_tool",
    "version": "1.1.0",
    "description": "Tools that enable LLMs to interact directly with the miro API."
  },
  "http_endpoint": {
    "metadata": {
      "object_type": "http_endpoint",
      "version": "1.2.0",
      "description": ""
    },
    "url": "https://api.miro.com/v2/boards/{board_id}/members",
    "http_method": "POST",
    "headers": {},
    "parameters": [
      {
        "name": "board_id",
        "tool_parameter_name": "board_unique_identifier",
        "description": "Unique identifier (ID) of the board to which the board member belongs.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Unique identifier (ID) of the board to which the board member belongs."
        },
        "accepted_as": "path",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "emails",
        "tool_parameter_name": "invitee_email_addresses",
        "description": "Email IDs of the users you want to invite to the board. You can invite up to 20 members per call.",
        "value_schema": {
          "val_type": "array",
          "inner_val_type": "string",
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "Email IDs of the users you want to invite to the board. You can invite up to 20 members per call."
        },
        "accepted_as": "body",
        "required": true,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      },
      {
        "name": "role",
        "tool_parameter_name": "board_member_role",
        "description": "Role of the board member. Inviting users with the role `owner` has the same effect as the role `coowner`.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": [
            "viewer",
            "commenter",
            "editor",
            "coowner",
            "owner"
          ],
          "properties": null,
          "inner_properties": null,
          "description": "Role of the board member. Inviting users with the role `owner` has the same effect as the role `coowner`."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": "commenter",
        "documentation_urls": []
      },
      {
        "name": "message",
        "tool_parameter_name": "invitation_message",
        "description": "The message that will be sent in the invitation email.",
        "value_schema": {
          "val_type": "string",
          "inner_val_type": null,
          "enum": null,
          "properties": null,
          "inner_properties": null,
          "description": "The message that will be sent in the invitation email."
        },
        "accepted_as": "body",
        "required": false,
        "deprecated": false,
        "default": null,
        "documentation_urls": []
      }
    ],
    "documentation_urls": [],
    "secrets": [
      {
        "arcade_key": "auth_token",
        "parameter_name": "Authorization",
        "accepted_as": "header",
        "formatted_value": "Bearer {authorization}",
        "description": "The OAuth token to use for authentication.",
        "is_auth_token": true
      }
    ],
    "request_body_spec": "{\n  \"content\": {\n    \"application/json\": {\n      \"schema\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"emails\": {\n            \"type\": \"array\",\n            \"description\": \"Email IDs of the users you want to invite to the board. You can invite up to 20 members per call.\",\n            \"items\": {\n              \"type\": \"string\",\n              \"example\": \"member@email.com\",\n              \"description\": \"Email IDs of the users you want to invite to the board. You can invite up to 20 members per call.\"\n            },\n            \"maxItems\": 20,\n            \"minItems\": 1\n          },\n          \"role\": {\n            \"type\": \"string\",\n            \"default\": \"commenter\",\n            \"description\": \"Role of the board member. Inviting users with the role `owner` has the same effect as the role `coowner`.\",\n            \"enum\": [\n              \"viewer\",\n              \"commenter\",\n              \"editor\",\n              \"coowner\",\n              \"owner\"\n            ]\n          },\n          \"message\": {\n            \"type\": \"string\",\n            \"description\": \"The message that will be sent in the invitation email.\",\n            \"example\": \"Hey there! Join my board and let's collaborate on this project!\"\n          }\n        },\n        \"required\": [\n          \"emails\"\n        ]\n      }\n    }\n  },\n  \"required\": true\n}",
    "use_request_body_schema_mode": false,
    "validate_request_body_schema": false
  }
}