Sign in
entities

Update entity

  Update entity information. Only the entity owner or admin can update.
put/api/v1/entities/{id}

Path parameters

idstring required

Entity CUID

Request body

namestring

Entity name or identifier

emailstring email

Contact email address

organizationstring

Organization or company name

websitestring

Website URL

metadataobject

Additional entity metadata

Example request

{
  "name": "Acme Validator",
  "email": "contact@acme-validator.com",
  "organization": "Acme Validator LLC",
  "website": "https://acme-validator.com",
  "metadata": {
    "region": "US-East",
    "validatorType": "professional",
    "tier": "premium"
  }
}

Response

Entity updated successfully

idstring required

Unique entity identifier

namestring required

Entity name

emailstring required

Contact email address

organizationstring

Organization name

websitestring

Website URL

status'active' | 'suspended' | 'inactive' required

Entity status

createdAtstring date-time required

Entity creation timestamp

updatedAtstring date-time required

Last update timestamp

lastActivityAtstring date-time

Last activity timestamp

metadataobject

Additional entity metadata

totalBidsnumber required

Total number of bids submitted

successfulBidsnumber required

Number of successful bids

successRatenumber required

Bid success rate (0-1)

activeApiKeysnumber required

Number of active API keys

rateLimitUsagenumber required

Current rate limit usage percentage

isActiveboolean required

Whether entity is currently active

hasApiKeysboolean required

Whether entity has any API keys

verificationStatus'unverified' | 'pending' | 'verified' | 'rejected' required

Entity verification status

Example response

{
  "id": "ent_1234567890abcdef",
  "name": "Acme Validator",
  "email": "contact@acme-validator.com",
  "organization": "Acme Validator LLC",
  "website": "https://acme-validator.com",
  "status": "active",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "lastActivityAt": "2024-01-01T12:30:00.000Z",
  "metadata": {
    "region": "US-East",
    "validatorType": "professional",
    "tier": "premium"
  },
  "totalBids": 1250,
  "successfulBids": 425,
  "successRate": 0.34,
  "activeApiKeys": 3,
  "rateLimitUsage": 65.5,
  "isActive": true,
  "hasApiKeys": true,
  "verificationStatus": "verified"
}

Changes