> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getunleash.io/api/create-public-signup-token/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getunleash.io/_mcp/server.

# Create a public signup token

POST https://app.unleash-instance.example.com/api/admin/invite-link/tokens
Content-Type: application/json

Lets administrators create a invite link to share with colleagues.  People that join using the public invite are assigned the `Viewer` role

Reference: https://docs.getunleash.io/api/create-public-signup-token

## Authentication

- `Authorization` header (required) — API key needed to access this API
- `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format

## Request

### Body (application/json)

This endpoint expects a publicSignupTokenCreateSchema.

- `name` (string, required) — The token's name.
- `expiresAt` (string, required) — The token's expiration date.

## Response

### 201

The resource was successfully created.

- `secret` (string, required) — The actual value of the token. This is the part that is used by Unleash to create an invite link
- `url` (string, required, nullable) — The public signup link for the token. Users who follow this link will be taken to a signup page where they can create an Unleash user.
- `name` (string, required) — The token's name. Only for displaying in the UI
- `enabled` (boolean, required) — Whether the token is active. This property will always be `false` for a token that has expired.
- `expiresAt` (string, required) — The time when the token will expire.
- `createdAt` (string, required) — When the token was created.
- `createdBy` (string, required, nullable) — The creator's email or username
- `role` (roleSchema, required) — Users who sign up using this token will be given this role.
- `users` (list of userSchema, optional, nullable) — Array of users that have signed up using the token.

## Errors

### 400 Bad Request Error

The request data does not match what we expect.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 401 Unauthorized Error

Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

### 403 Forbidden Error

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

- `id` (string, optional) — The ID of the error instance
- `name` (string, optional) — The name of the error kind
- `message` (string, optional) — A description of what went wrong.

## Types

### roleSchema

A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform

- `id` (integer, required) — The role id
- `type` (string, required) — A role can either be a global root role (applies to all projects) or a project role
- `name` (string, required) — The name of the role
- `description` (string, optional) — A more detailed description of the role and what use it's intended for
- `project` (string, optional, nullable) — What project the role belongs to

### userSchema

An Unleash user

- `id` (integer, required) — The user id
- `name` (string, optional, nullable) — Name of the user
- `email` (string, optional) — Email of the user
- `username` (string, optional, nullable) — A unique username for the user
- `imageUrl` (string, optional) — URL used for the user profile image
- `inviteLink` (string, optional) — If the user is actively inviting other users, this is the link that can be shared with other users
- `loginAttempts` (integer, optional) — How many unsuccessful attempts at logging in has the user made
- `emailSent` (boolean, optional) — Is the welcome email sent to the user or not
- `rootRole` (integer, optional) — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned
- `seenAt` (string, optional, nullable) — The last time this user logged in
- `createdAt` (string, optional) — The user was created at this time
- `accountType` (enum, optional) — A user is either an actual User or a Service Account
  - Allowed values: `User`, `Service Account`
- `permissions` (list of string, optional) — Deprecated
- `scimId` (string, optional, nullable) — The SCIM ID of the user, only present if managed by SCIM
- `seatType` (string, optional, nullable) — The seat type of this user
- `companyRole` (string, optional, nullable) — The role of the user within the company.
- `productUpdatesEmailConsent` (boolean, optional, nullable) — Whether the user has consented to receive product update emails.
- `activeSessions` (integer, optional, nullable) — Count of active browser sessions for this user
- `deletedSessions` (double, optional) — Experimental. The number of deleted browser sessions after last login

## Examples

**Request**

```json
{
  "name": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
}
```

**Response**

```json
{
  "secret": "a3c84b25409ea8ca1782ef17f94a42fc",
  "url": "https://sandbox.getunleash.io/enterprise/new-user?invite=a3c84b25409ea8ca1782ef17f94a42fc",
  "name": "Invite public viewers",
  "enabled": true,
  "expiresAt": "2023-04-12T11:13:31.960Z",
  "createdAt": "2023-04-12T11:13:31.960Z",
  "createdBy": "someone@example.com",
  "role": {
    "id": 9,
    "type": "root",
    "name": "Editor",
    "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
    "project": "default"
  },
  "users": [
    {
      "id": 123,
      "name": "User",
      "email": "user@example.com",
      "username": "hunter",
      "imageUrl": "https://example.com/242x200.png",
      "inviteLink": "http://localhost:4242/invite-link/some-secret",
      "loginAttempts": 3,
      "emailSent": false,
      "rootRole": 1,
      "seenAt": "2023-06-30T11:42:00.345Z",
      "createdAt": "2023-06-30T11:41:00.123Z",
      "accountType": "User",
      "permissions": [
        "string"
      ],
      "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
      "seatType": "Regular",
      "companyRole": "Developer",
      "productUpdatesEmailConsent": false,
      "activeSessions": 2,
      "deletedSessions": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://app.unleash-instance.example.com/api/admin/invite-link/tokens"

payload = {
    "name": "string",
    "expiresAt": "2024-01-15T09:30:00Z"
}
headers = {
    "Authorization": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.unleash-instance.example.com/api/admin/invite-link/tokens';
const options = {
  method: 'POST',
  headers: {Authorization: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"string","expiresAt":"2024-01-15T09:30:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.unleash-instance.example.com/api/admin/invite-link/tokens"

	payload := strings.NewReader("{\n  \"name\": \"string\",\n  \"expiresAt\": \"2024-01-15T09:30:00Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.unleash-instance.example.com/api/admin/invite-link/tokens")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"string\",\n  \"expiresAt\": \"2024-01-15T09:30:00Z\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.unleash-instance.example.com/api/admin/invite-link/tokens")
  .header("Authorization", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"string\",\n  \"expiresAt\": \"2024-01-15T09:30:00Z\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.unleash-instance.example.com/api/admin/invite-link/tokens', [
  'body' => '{
  "name": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
}',
  'headers' => [
    'Authorization' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.unleash-instance.example.com/api/admin/invite-link/tokens");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"string\",\n  \"expiresAt\": \"2024-01-15T09:30:00Z\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "string",
  "expiresAt": "2024-01-15T09:30:00Z"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/api/admin/invite-link/tokens")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```