api_b2b_magic_v1_b2b_magic_links_email_InviteRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_b2b_magic_v1_b2b_magic_links_email_InviteRequest",
  "title": "api_b2b_magic_v1_b2b_magic_links_email_InviteRequest",
  "type": "object",
  "properties": {
    "organization_id": {
      "type": "string",
      "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience."
    },
    "email_address": {
      "type": "string",
      "description": "The email address of the Member."
    },
    "invite_redirect_url": {
      "type": "string",
      "description": "The URL that the Member clicks from the invite Email Magic Link. This URL should be an endpoint in the backend server that verifies\n  the request by querying Stytch's authenticate endpoint and finishes the invite flow. If this value is not passed, the default `invite_redirect_url`\n  that you set in your Dashboard is used. If you have not set a default `invite_redirect_url`, an error is returned."
    },
    "invited_by_member_id": {
      "type": "string",
      "description": "The `member_id` of the Member who sends the invite."
    },
    "name": {
      "type": "string",
      "description": "The name of the Member."
    },
    "trusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object for storing application-specific data or identity-provider-specific data."
    },
    "untrusted_metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "An arbitrary JSON object of application-specific data. These fields can be edited directly by the\n  frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata)\n  for complete field behavior details."
    },
    "invite_template_id": {
      "type": "string",
      "description": "Use a custom template for invite emails. By default, it will use your default email template. Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in customization options or custom HTML templates with type \u201cMagic Links - Invite\u201d."
    },
    "locale": {
      "$ref": "#/components/schemas/api_b2b_magic_v1_InviteRequestLocale",
      "description": "Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), French (`\"fr\"`) and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Roles to explicitly assign to this Member. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment)\n   for more information about role assignment."
    },
    "invite_expiration_minutes": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "The expiration time, in minutes, for an invite email. If not accepted within this time frame, the invite will need to be resent. Defaults to 10080 (1 week) with a minimum of 5 and a maximum of 10080."
    }
  },
  "description": "Request type",
  "required": [
    "organization_id",
    "email_address"
  ]
}