{
  "args": {
    "channel_ids": {
      "desc": "A comma-separated list of `channel_id`s for this user to join. At least one channel is required.",
      "example": "C1A2B3C4D,C26Z25Y24",
      "required": true,
      "type": "string"
    },
    "custom_message": {
      "desc": "An optional message to send to the user in the invite email.",
      "example": "Come and join our team!",
      "required": false,
      "type": "string"
    },
    "email": {
      "desc": "The email address of the person to invite.",
      "example": "joe@email.com",
      "required": true,
      "type": "string"
    },
    "email_password_policy_enabled": {
      "desc": "Allow invited user to sign in via email and password. Only available for Enterprise org teams via admin invite.",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "guest_expiration_ts": {
      "desc": "Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.",
      "example": "0123456789.012345",
      "required": false,
      "type": "string"
    },
    "is_restricted": {
      "desc": "Is this user a multi-channel guest user? (default: false)",
      "required": false,
      "type": "boolean"
    },
    "is_ultra_restricted": {
      "desc": "Is this user a single channel guest user? (default: false)",
      "required": false,
      "type": "boolean"
    },
    "real_name": {
      "desc": "Full name of the user.",
      "example": "{\"full_name\":\"Joe Smith\"}",
      "required": false,
      "type": "string"
    },
    "resend": {
      "desc": "Allow this invite to be resent in the future if a user has not signed up yet. Resending can only be done via the UI and has no expiration. (default: false)",
      "example": "true",
      "required": false,
      "type": "boolean"
    },
    "team_id": {
      "desc": "The ID (`T1234`) of the workspace.",
      "required": true
    }
  },
  "desc": "Invite a user to a workspace.",
  "errors": {
    "already_in_team": "The user is already on the team.",
    "already_in_team_invited_user": "The user has already been invited to the team.",
    "failed_looking_up_user": "We couldn't find the requested user.",
    "failed_to_send_invite": "The invite failed to send.",
    "failed_to_validate_caller": "The token calling this method doesn't have permission to invite a user.",
    "failed_to_validate_channels": "`channel_ids` was invalid.",
    "failed_to_validate_custom_message": "`extra_message` was invalid.",
    "failed_to_validate_expiration": "`expiration_ts` was invalid.",
    "failed_to_validate_team": "The team calling this method was invalid.",
    "feature_not_enabled": "The Admin APIs feature is not enabled for this team.",
    "invalid_email": "Email address was not valid.",
    "not_an_admin": "The user token does not have admin privileges.",
    "team_not_found": "`team_id` was not found.",
    "user_disabled": "The user is disabled."
  },
  "rate_limit": {
    "label": "Tier 2: 20+ per minute",
    "url": "https://docs.slack.dev/apis/web-api/rate-limits"
  },
  "scopes": {
    "user": [
      {
        "name": "admin.users:write",
        "url": "https://docs.slack.dev/reference/scopes/admin.users.write"
      }
    ]
  }
}