---
title: "Update a public signup token"
method: PUT
path: "/api/admin/invite-link/tokens/{token}"
tags: ["Public signup tokens"]
---

# Update a public signup token

`PUT /api/admin/invite-link/tokens/{token}`

Update information about a specific token. The `:token` part of the URL should be the token's secret.

## Path parameters

- `token` string, required

## Request body

- PublicSignupTokenUpdateSchema — Used by Unleash for updating a token's expiration date or, when deleting the invite link, it's status
  - `expiresAt` string, date-time — The token's expiration date.
  - `enabled` boolean — Whether the token is active or not.

## Response `200`

publicSignupTokenSchema

- PublicSignupTokenSchema — Used for transporting a [public invite link](https://docs.getunleash.io/concepts/public-signup#public-sign-up-tokens)
  - `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, nullable, required — 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, date-time, required — The time when the token will expire.
  - `createdAt` string, date-time, required — When the token was created.
  - `createdBy` string, nullable, required — The creator's email or username
  - `users` UserSchema[], nullable — Array of users that have signed up using the token.
    - `id` integer, required — The user id
    - `name` string, nullable — Name of the user
    - `email` string — Email of the user
    - `username` string, nullable — A unique username for the user
    - `imageUrl` string — URL used for the user profile image
    - `inviteLink` string — If the user is actively inviting other users, this is the link that can be shared with other users
    - `loginAttempts` integer — How many unsuccessful attempts at logging in has the user made
    - `emailSent` boolean — Is the welcome email sent to the user or not
    - `rootRole` integer — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned
    - `seenAt` string, date-time, nullable — The last time this user logged in
    - `createdAt` string, date-time — The user was created at this time
    - `accountType` 'User' | 'Service Account' — A user is either an actual User or a Service Account
    - `permissions` string[] — Deprecated
    - `scimId` string, nullable — The SCIM ID of the user, only present if managed by SCIM
    - `seatType` string, nullable — The seat type of this user
    - `companyRole` string, nullable — The role of the user within the company.
    - `productUpdatesEmailConsent` boolean, nullable — Whether the user has consented to receive product update emails.
    - `activeSessions` integer, nullable — Count of active browser sessions for this user
    - `deletedSessions` number — Experimental. The number of deleted browser sessions after last login
  - `role` RoleSchema, required — 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 — A more detailed description of the role and what use it's intended for
    - `project` string, nullable — What project the role belongs to

## Other responses

- `400` — The request data does not match what we expect.
- `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
- `403` — The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

---

[API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/revisions/b2c3116e633e/schema)