diff --git a/methods/conversations/conversations.inviteShared.json b/methods/conversations/conversations.inviteShared.json new file mode 100644 index 00000000..f06c4595 --- /dev/null +++ b/methods/conversations/conversations.inviteShared.json @@ -0,0 +1,94 @@ +{ + "group": "conversations", + "name": "conversations.inviteShared", + "deprecated": false, + "desc": "Sends an invitation to a Slack Connect channel", + "args": { + "channel": { + "required": true, + "example": "C1234567890", + "desc": "ID of the channel on your team that you'd like to share.", + "type": "channel" + }, + "emails": { + "required": false, + "desc": "Optional email to receive this invite. Either emails or user_ids must be provided. Only one email or one user ID may be invited at a time.", + "type": "array" + }, + "external_limited": { + "required": false, + "example": "true", + "desc": "Optional boolean on whether invite is to a external limited member. Defaults to true.", + "type": "boolean" + }, + "user_ids": { + "required": false, + "desc": "Optional user_id to receive this invite. Either emails or user_ids must be provided. Only one email or one user ID may be invited at a time.", + "type": "array" + } + }, + "response": { + "examples": [ + "{\n \"ok\": true,\n \"invite_id\": \"I02UKAJ6RJA\",\n \"is_legacy_shared_channel\": false\n}", + "{\n \"ok\": false,\n \"error\": \"restricted_action\"\n}" + ] + }, + "errors": { + "already_in_channel": "User is already in the channel.", + "cannot_share_cross_workspace_channel": "You cannot share a cross-workspace or org-wide channel.", + "cannot_share_mandatory_channel": "You cannot share #general or mandatory channels.", + "channel_archived": "You cannot share an archived channel.", + "channel_not_found": "The channel provided was not found.", + "connection_limit_exceeded": "This channel has hit the limit of external connections.", + "connection_limit_exceeded_pending": "This channel already has a pending invite.", + "invalid_channel_type": "You cannot share MPDMs or DMs.", + "invalid_email": "At least one email address provided is invalid.", + "invite_lookup_error": "An error occurred while attempting to look for existing invites.", + "invite_not_found": "An error occurred while inviting users.", + "legacy_connection_limit_exceeded": "You cannot share a legacy ESC channel with a third team.", + "member_limit_exceeded": "This channel that has hit the limit of members.", + "message_too_long": "The provided message was longer than 560 characters.", + "not_allowed_for_grid_workspace": "This workspace does not have Slack Connect enabled.", + "not_owner": "Only the host organization for a channel can request to share it.", + "not_paid": "This feature is only available to paid teams.", + "not_supported": "This channel cannot be shared.", + "ratelimit": "The rate-limit for this method has been reached. The ratelimit is applied on a per-user basis when you pass the emails parameter.", + "recipients_not_specified": "Bots are required to specify which users to invite.", + "restricted_action": "A team preference does not allow this authorization to send invites.", + "too_many_emails": "Too many email recipients were passed in the emails parameter.", + "url_in_message": "The message contained a URL.", + "user_not_found": "User lookup failed.", + "access_denied": "Access to a resource specified in the request is denied.", + "account_inactive": "Authentication token is for a deleted user or workspace when using a bot token.", + "deprecated_endpoint": "The endpoint has been deprecated.", + "ekm_access_denied": "Administrators have suspended the ability to post a message.", + "enterprise_is_restricted": "The method cannot be called from an Enterprise.", + "invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.", + "is_bot": "This method cannot be called by a legacy bot.", + "user_is_restricted": "This method cannot be called by a restricted user or single channel guest.", + "method_deprecated": "The method has been deprecated.", + "missing_scope": "The token used is not granted the specific scope permissions required to complete this request.", + "not_allowed_token_type": "The token type used in this request is not allowed.", + "not_authed": "No authentication token provided.", + "no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.", + "org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.", + "token_expired": "Authentication token has expired.", + "token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a user token.", + "two_factor_setup_required": "Two factor setup is required.", + "team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.", + "accesslimited": "Access to this method is limited on the current network.", + "fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.", + "internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.", + "invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.", + "invalid_arguments": "The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.", + "invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.", + "invalid_charset": "The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.", + "invalid_form_data": "The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.", + "invalid_post_type": "The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.", + "missing_post_type": "The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.", + "ratelimited": "The request has been ratelimited. Refer to the Retry-After header for when to retry the request.", + "request_timeout": "The method was called via a POST request, but the POST data was either missing or truncated.", + "service_unavailable": "The service is temporarily unavailable.", + "team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete." + } +} \ No newline at end of file