# issueCollaboratorInvite

mutation · in the family [Identity and access](/reference/identity-and-access/)

## What it does

Send a collaborator their sign-up invite — a one-time code you pass along; issuing again replaces the old one.

STAFF: mint (or ROTATE) the ONE outstanding show-once invite token for an ACTIVE collaborator: the plaintext token rides THIS result ONCE; a re-issue makes the prior token STALE (the pointer-currency law — the single live slot); a non-active collaborator refuses CONFLICT/REF_STATE. ⚠ NO staff password-set lane exists on this plane EVER — this rotation IS the recovery lane (the merchant never knows the secret). Template class; requires the unrestricted capability.

## What happens

The code appears ONCE in the result and expires in 7 days; the system never emails it — you convey it.

## Careful

Whoever redeems the code becomes this collaborator — convey it privately.

## Who may call it

Capability area: **Identity and access** — Who can sign in and what each role allows — users, roles and their assignments.

- Owner
- System Administrator
- An API key whose scope allows `api:issueCollaboratorInvite`

## Arguments

| Name | Type | Required | Notes |
| --- | --- | --- | --- |
| `collaboratorId` | [ID](/types/#scalars) `ID!` | yes | No further notes. |

## Returns

[CollaboratorInviteMint](/types/CollaboratorInviteMint/) `CollaboratorInviteMint!` — The show-once invite mint.

## Example request

```graphql
mutation ExampleIssueCollaboratorInvite($collaboratorId: ID!) {
  issueCollaboratorInvite(collaboratorId: $collaboratorId) {
    inviteToken
    expiresAt
  }
}
```

Variables:

```json
{
  "collaboratorId": "01900000-0000-7000-8000-4cebc5980000"
}
```

Send it with the envelope naming the version: `"extensions": {"at": {"version": {"name":"genesis","number":0}}}`.

## Example response

```json
{
  "data": {
    "issueCollaboratorInvite": {
      "inviteToken": "<your session token>",
      "expiresAt": "2027-01-31T00:00:00.000Z"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}
```

## Errors this call can answer

- `VALIDATION/INVALID` — Something in the request is not valid. ([VALIDATION](/errors/VALIDATION/))
- `AUTHN/REQUIRED` — Sign in to do this. ([AUTHN](/errors/AUTHN/))
- `AUTHZ/FORBIDDEN` — Your role does not allow this action. ([AUTHZ](/errors/AUTHZ/))
- `RATE_LIMIT/THROTTLED` — Too many requests in a short time. ([RATE_LIMIT](/errors/RATE_LIMIT/))
- `NOT_FOUND/*` — That record could not be found. ([NOT_FOUND](/errors/NOT_FOUND/))
- `CONFLICT/*` — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. ([CONFLICT](/errors/CONFLICT/))
- `VALIDATION/VERSION_REQUIRED` — The request did not say which app version it came from. ([VALIDATION](/errors/VALIDATION/))

## Used in

- [Bring in an outside collaborator](/use-cases/bring-in-an-outside-collaborator/)