PUT
/
v1
/
key
/
{id}
curl --request PUT \
  --url https://api.formizee.com/v1/key/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My New Key",
  "expiresAt": "90-days"
}'
{
  "id": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "name": "My New Key",
  "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "lastAccess": "2024-07-23 12:41:45.38215",
  "expiresAt": "2024-07-23 12:41:45.38215"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The id of the key

Body

application/json
​
name
string

The name of the key

Required string length: 4 - 64
​
expiresAt
enum<string>

The expiration date of the key

Available options:
1-day,
7-days,
30-days,
60-days,
90-days,
180-days,
1-year,
never

Response

200
application/json
Update a key
​
id
string
required

The id of the key

​
name
string
required

The name of the key

Required string length: 4 - 64
​
workspaceId
string
required

The id of the workspace

​
expiresAt
string
required

The expiration date of the key

​
lastAccess
string

The last time the key was used

Was this page helpful?

Suggest editsRaise issue
Create a keyDelete a key