clerk.create_invitation

Parameters schema

{
  "type": "object",
  "title": "create_clerk_invitationArguments",
  "required": [
    "email_address"
  ],
  "properties": {
    "role": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Role",
      "default": null,
      "description": "Optional role to assign when the invitation is accepted."
    },
    "redirect_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Redirect Url",
      "default": null,
      "description": "Optional URL to redirect the invitee to after accepting."
    },
    "email_address": {
      "type": "string",
      "title": "Email Address",
      "description": "Email address to invite."
    },
    "public_metadata": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "title": "Public Metadata",
      "default": null,
      "description": "Optional public metadata as a JSON object attached to the invitation."
    },
    "clerk_instance_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Clerk Instance Id",
      "default": null,
      "description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
    }
  }
}

No endpoints wrapped at confidence ≥ 0.70.

Parent server