post/orgs/{id}/claim

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/orgs/{id}/claim
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Organization to claim

Request body

object required

Claim parameters

Response

OK

idstring required

Unique identifier for the organization

namestring required

Display name of the organization

slugstring required

URL-friendly identifier for the organization

clerkOrgIdstring nullable required

External Clerk organization ID, null if not linked

tier'FREE' | 'STARTER' | 'GROWTH' | 'ENTERPRISE' required

Current subscription tier

keyRotatedAtstring date-time nullable required

ISO 8601 timestamp of the last master-key rotation, null if never rotated

settingsobject required

Arbitrary key-value settings for the organization

createdAtstring date-time required

ISO 8601 timestamp when the organization was created

updatedAtstring date-time required

ISO 8601 timestamp when the organization was last modified

Changes

No recorded changes to this operation across all 1 revision of this API.