---
title: "InviteInput"
description: "an address and a role to invite to the tenant, with where the role is held"
section: concepts
address: /concepts/inviteinput
contract: 0476e35e6e275db5
---

# InviteInput

an address and a role to invite to the tenant, with where the role is held

[figure: InviteInput is a value at none scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | value |
| scope | none |
| key | none |
| store | none |
| family | harness |



## Fields


| field | type | required | note |
|---|---|---|---|
| `address` | `text` | yes |  |
| `role` | `text` | yes |  |
| `held_on` | [Scope](/concepts/scope) | no | the tenant, brand or strategy the role is held on; absent means the whole tenant, which a guest may not hold (a guest holds roles only on the brands they were invited to) |



## Routes that use it
- [`/v1/act/invite`](/reference/act/invite) takes it as input