Update organization

put

https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}

Updates one or more fields on an existing organization identified by its internal ID or externalSourceId. Only the fields present in the request body are updated; omitted fields are left unchanged. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it.

Path Params

organizationId

string

required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

Query Params

include

string

String. Comma-separated list of optional data sections to include in the response. Accepted values: address, invoiceDetails, settings, design, partner.

Body Params

At least one known property must be present in the request body. Unknown properties are ignored when combined with at least one known property, but a body containing only unknown properties returns 400 with code NO_KNOWN_JSON_PROPERTIES.

string | null

Optional. When provided, must match the organization's internal ID or externalSourceId in the URL. Returns 400 with code INVALID_ID if the value does not match.

name

string

length ≤ 255

Display name of the organization. String with maximum length of 255 characters.

vat

string | null

Organization registration number (VAT/company number). String with maximum length of 255 characters.

phone

string | null

Main phone number of the organization. String with maximum length of 255 characters.

externalSourceId

string | null

Caller-supplied identifier used to address this organization from an external system. Must be unique within the client application. String with maximum length of 255 characters.

supportAccessEndDate

date-time | null

ISO 8601 timestamp until which Findity support staff has elevated access to this organization.

sendEventToExternalSystem

boolean | null

Whether events from this organization are sent to the external system.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK — returns the updated organization

400Bad request

403Forbidden — organization not found or access denied