# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## invite_members Invite people to an Organization and/or its Workspaces with grants the caller holds; list, re-send, or revoke invitations. Call options first to see grantable roles and Workspaces, then invite; list shows status (accepted means joined). Never grants more than the caller holds, and cannot accept on the invitee's behalf; the invitee accepts from the email. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: orgMember:invite, orgMember:read, workspaceMember:invite, workspaceMember:read Risk: write; confirmation: explicit; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "InviteMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "InviteMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "invitationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "InviteMembersOutput": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "organizationName": { "$ref": "#/$defs/ShortText" }, "organization": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, { "type": "null" } ] }, "allWorkspaces": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "workspaceId", "name", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "name", "permissions" ] } } }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/RoleId" }, "name": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "system": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "id", "name", "scope", "system", "permissions" ], "patternProperties": { "^(?!(?:id|name|scope|system|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "scope", "system", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organization", "allWorkspaces", "workspaces", "roles" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organization|allWorkspaces|workspaces|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organization", "allWorkspaces", "workspaces", "roles" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expired": { "type": "boolean" }, "invitedByUserId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "resendCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ], "patternProperties": { "^(?!(?:id|organizationId|email|grants|status|expiresAt|expired|invitedByUserId|resendCount|lastSentAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ] } }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expired": { "type": "boolean" }, "invitedByUserId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "resendCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ], "patternProperties": { "^(?!(?:id|organizationId|email|grants|status|expiresAt|expired|invitedByUserId|resendCount|lastSentAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ] } } }, { "type": "object", "properties": { "revoked": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "revoked" ], "patternProperties": { "^(?!(?:revoked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "revoked" ] } ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/InviteMembersOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/InviteMembersOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationInvitations.options`: `GET /v1/organizations/:organizationId/invitations/options` - `organizationInvitations.create`: `POST /v1/organizations/:organizationId/invitations` - `organizationInvitations.list`: `GET /v1/organizations/:organizationId/invitations` - `organizationInvitations.resend`: `POST /v1/organizations/:organizationId/invitations/:invitationId/resend` - `organizationInvitations.revoke`: `DELETE /v1/organizations/:organizationId/invitations/:invitationId`