Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Update a company

Updates the Company name, settings or slug, with optional slug regeneration from the new name.

PUT https://app.upfour.io/v1/organization
PUT https://app.upfour.io/v1/organization

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs organization.write.
Body
More fields3
slug_from_name Lets a slug that was generated from the old name follow the new name. Ignored when slug is sent.

1 more field is only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope organization.write stable returns 200

Body

application/json required 4 fields

All other fields4 fields
namestring

Empty keeps the current name.

settingsobjectfree-form keys

Replaces the whole settings object; omitted leaves it unchanged. Checked keys: timezone (IANA name), date_format (day_month_year, month_day_year or iso), default_language (en or de) and incident_screenshots_default (boolean). default_language, incident_screenshots_default and the audit drain keep their stored value when not sent; the report identity is only changed through /organization/report-branding.

slugstring

Empty keeps the current slug. A new slug has to derive from the Company name or from a verified domain of the Company.

slug_from_nameboolean

Lets a slug that was generated from the old name follow the new name. Ignored when slug is sent.

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data Organization
Organization · 8 fields
FieldTypeDescription
created_at string (date-time)
id uuid
name string
owner_id uuid
settings object · nullable free-form keys Company settings, for example timezone, date_format (day_month_year, month_day_year or iso), default_language (en or de) and incident_screenshots_default. The audit drain secret is never returned.
slug string
updated_at string (date-time)
deleted_at string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.