Skip to content
/
Update tenant

Update tenant

Request

Rename a tenant, replace its metadata, or both. Requires a Full access key. A field that is omitted is left unchanged. metadata replaces the tenant's metadata as a whole rather than merging into it, so send {} to clear it.

Security
x-api-key
Path
tenantIdstring, (uuid)required

Unique identifier for the tenant.

Bodyapplication/jsonrequired
non-empty
namestring, [ 3 .. 75 ] characters

Human-readable name for the tenant. Letters, digits, spaces and ( ) , . ' - are allowed.

Example:"Acme Corporation"
metadataobject(Tenant Metadata)

Key/value metadata set by the partner that manages this tenant. Only present for tenants managed by a partner. When a partner manages the tenant but has set no metadata, it is present as an empty object rather than omitted or null. A partner may set at most 10 entries, with keys up to 40 characters and values up to 256 characters.

Example:
{
  "customerRef": "ACME-001",
  "region": "emea"
}
curl -i -X PATCH \
  'https://eu1.partner-api.pushsecurity.com/v1/tenants/{tenantId}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Bodyapplication/json
idstring, (uuid)required

Unique identifier for the tenant.

Example:"0c2e1b84-ee1d-4ef9-a3b3-4b2e1d5c8f27"
namestringrequired

Human-readable name for the tenant. Names are not unique across your tenants.

Example:"Acme Corporation"
metadataobject(Tenant Metadata)required

Key/value metadata set by the partner that manages this tenant. Only present for tenants managed by a partner. When a partner manages the tenant but has set no metadata, it is present as an empty object rather than omitted or null. A partner may set at most 10 entries, with keys up to 40 characters and values up to 256 characters.

Example:
{
  "customerRef": "ACME-001",
  "region": "emea"
}
creationTimestampinteger, (int64)required

When the tenant was created, as a UNIX timestamp in seconds.

Example:1718100000
deleteInProgressbooleanrequired

Whether the tenant is currently being deleted. This can only be true in the tenant list: reading a single tenant that is being deleted returns a 409 instead. Once deleted the tenant will no longer be listed.

Example:false
Response
{
  "id": "0c2e1b84-ee1d-4ef9-a3b3-4b2e1d5c8f27",
  "name": "Acme Corporation",
  "metadata": {
    "customerRef": "ACME-001",
    "region": "emea"
  },
  "creationTimestamp": 1718100000,
  "deleteInProgress": false
}