API Reference
Reference for the REST API
Update information for an existing organization, such as its name.
cURL
curl --request PUT \ --url https://api.xata.tech/organizations/{organizationID} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "id": "<string>", "name": "<string>" } '
{ "id": "<string>", "name": "<string>", "status": { "status": "enabled", "disabled_by_admin": true, "billing_status": "ok", "last_updated": "2023-11-07T05:31:56Z", "admin_reason": "<string>", "billing_reason": "<string>" } }
The access token received from the authorization server in the OAuth 2.0 flow.
Unique identifier for a specific organization
Unique identifier for the organization to update
New name for the organization
Organization successfully updated
Organization details including ID and name
Unique identifier for the organization
Human-readable name of the organization
Current status of the organization
Show child attributes
Indicates whether the organization is active, it's computed as !disabled_by_admin AND billing_status == 'ok'
!disabled_by_admin AND billing_status == 'ok'
enabled
disabled
Indicates if the organization has been disabled by an admin
Indicates the status of the organization from a billing perspective
ok
no_payment_method
invoice_overdue
unknown
Timestamp of the last update to the organization's status
Reason for the current admin status
Reason for the current billing status
Was this page helpful?