CreateInvitationRequestBody

Required parameters

Fields

Field	Type	Required	Description	Example
`email_address`	str	✔️	The email address the invitation will be sent to	user@example.com
`public_metadata`	Dict[str, Any]	➖	Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.	{}
`redirect_url`	Optional[str]	➖	Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a custom flow and you're not using Clerk Hosted Pages or Clerk Components.	https://example.com/welcome
`notify`	OptionalNullable[bool]	➖	Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to `true`.	true
`ignore_existing`	OptionalNullable[bool]	➖	Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user.	false
`expires_in_days`	OptionalNullable[int]	➖	The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
`template_slug`	Optional[models.TemplateSlug]	➖	The slug of the email template to use for the invitation email.