POST /invites

Default value: "application/x-www-form-urlencoded"

A list containing the IDs of the channels that the newly created user will be automatically subscribed to if the invitation is accepted, in addition to any default channels that the new user may be subscribed to based on the include_realm_default_subscriptions parameter.

Requested channels must either be default channels for the organization, or ones the acting user has permission to add subscribers to.

This list must be empty if the current user has the unlikely configuration of being able to send invitations while lacking permission to subscribe other users to channels.

Changes: Prior to Zulip 10.0 (feature level 342), default channels that the acting user did not directly have permission to add subscribers to would be rejected.

Before Zulip 7.0 (feature level 180), specifying stream_ids as an empty list resulted in an error.

Custom message text, in Zulip Markdown format, to be sent by the Welcome Bot to new users that join the organization via this invitation.

Maximum length is 8000 Unicode code points.

Only organization administrators can use this feature; for other users, the value is always null.

• null: the organization's default welcome_message_custom_text is used.
• Empty string: no Welcome Bot custom message is sent.
• Otherwise, the provided string is the custom message.

Changes: New in Zulip 11.0 (feature level 416).

The string containing the email addresses, separated by commas or newlines, that will be sent an invitation.

The number of minutes before the invitation will expire. If null, the invitation will never expire. If unspecified, the server will use a default value (based on the INVITATION_LINK_VALIDITY_MINUTES server setting, which defaults to 14400, i.e. 10 days) for when the invitation will expire.

Changes: New in Zulip 6.0 (feature level 126). Previously, there was an invite_expires_in_days parameter, which specified the duration in days instead of minutes.

A boolean indicating whether the referrer would like to receive a direct message from notification bot when a user account is created using this invitation.

Changes: New in Zulip 9.0 (feature level 267). Previously, referrers always received such direct messages.

Default value: true

Boolean indicating whether the newly created user should be subscribed to the default channels for the organization.

Note that this parameter can be true even if the user creating the invitation does not generally have permission to subscribe other users to channels.

Changes: New in Zulip 9.0 (feature level 261). Previous versions of Zulip behaved as though this parameter was always false; clients needed to include the organization's default channels in the stream_ids parameter for a newly created user to be automatically subscribed to them.

Default value: false

The organization-level role of the user that is created when the invitation is accepted. Possible values are:

• 100 = Organization owner
• 200 = Organization administrator
• 300 = Organization moderator
• 400 = Member
• 600 = Guest

Users can only create invitation links for roles with equal or stricter restrictions as their own. For example, a moderator cannot invite someone to be an owner or administrator, but they can invite them to be a moderator or member.

Changes: In Zulip 4.0 (feature level 61), added support for inviting users as moderators.

Valid values:

• 100
• 200
• 300
• 400
• 600

Default value: 400

A list containing the IDs of the user groups that the newly created user will be automatically added to if the invitation is accepted. If the list is empty, then the new user will not be added to any user groups. The acting user must have permission to add users to the groups listed in this request.

Changes: New in Zulip 10.0 (feature level 322).