Skip to main content
PATCH
/
v1
/
organizations
/
{organizationId}
/
api-keys
/
{keyId}
Update an organization API key
curl --request PATCH \
  --url https://api.usefoil.com/v1/organizations/{organizationId}/api-keys/{keyId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Growth Workspace",
  "allowed_origins": [
    "https://app.acme.co/signup"
  ],
  "scopes": [
    "*"
  ]
}
'
{
  "data": {
    "object": "api_key",
    "id": "key_6cw04zdmetw8t5rsdppadhper0",
    "type": "publishable",
    "environment": "live",
    "name": "Acme Growth Workspace",
    "status": "active",
    "allowed_origins": [
      "https://app.acme.co/signup"
    ],
    "scopes": [
      "*"
    ],
    "rate_limit": 1,
    "key_preview": "FOIL_SAMPLE_KEY",
    "display_key": "FOIL_SAMPLE_KEY",
    "revealed_key": "FOIL_SAMPLE_KEY",
    "last_used_at": "2026-03-24T20:00:05.000Z",
    "created_at": "2026-03-24T20:00:00.000Z",
    "rotated_at": "2026-03-24T20:00:05.000Z",
    "revoked_at": "2026-03-24T20:00:05.000Z",
    "grace_expires_at": "2026-03-24T20:00:05.000Z"
  },
  "meta": {
    "request_id": "req_cf147349a4134208aebb8c70e25fb7e1"
  }
}

Path Parameters

​
organizationId
string
required
Pattern: ^org_[0123456789abcdefghjkmnpqrstvwxyz]{26}$
Example:

"org_f6m39y94nh6fs513q03skj929c"

​
keyId
string
required
Pattern: ^key_[0123456789abcdefghjkmnpqrstvwxyz]{26}$
Example:

"key_6cw04zdmetw8t5rsdppadhper0"

Body

application/json
​
name
string
Example:

"Acme Growth Workspace"

​
allowed_origins
string<uri>[]
Example:
["https://app.acme.co/signup"]
​
scopes
enum<string>[]

When updating a secret key, provide at least one supported secret-key scope, or ["*"] for all current and future scopes.

Minimum array length: 1
Available options:
*,
sessions:list,
sessions:read,
sessions:update,
fingerprints:list,
fingerprints:read,
organizations:create,
organizations:read,
organizations:update,
api_keys:read,
api_keys:manage,
gate:agent_tokens:verify,
gate:agent_tokens:revoke,
gate:login_sessions:consume,
gate:services:read,
gate:services:manage,
webhooks:read,
webhooks:manage
Example:
["*"]

Response

Revoked API key response.

​
data
object
required
Example:
{
  "object": "api_key",
  "id": "key_6cw04zdmetw8t5rsdppadhper0",
  "type": "publishable",
  "environment": "live",
  "name": "Acme Growth Workspace",
  "status": "active",
  "allowed_origins": ["https://app.acme.co/signup"],
  "scopes": ["*"],
  "rate_limit": 1,
  "key_preview": "FOIL_SAMPLE_KEY",
  "display_key": "FOIL_SAMPLE_KEY",
  "revealed_key": "FOIL_SAMPLE_KEY",
  "last_used_at": "2026-03-24T20:00:05.000Z",
  "created_at": "2026-03-24T20:00:00.000Z",
  "rotated_at": "2026-03-24T20:00:05.000Z",
  "revoked_at": "2026-03-24T20:00:05.000Z",
  "grace_expires_at": "2026-03-24T20:00:05.000Z"
}
​
meta
object
required
Example:
{
  "request_id": "req_cf147349a4134208aebb8c70e25fb7e1"
}