Update Organization

Operation ID: organizations.update
PATCH
https://api.authpi.com/v1/accounts/{account_id}/issuers/{issuer_id}/organizations/{org_id}

Update an existing organization

Request

Request body

Schema | application/json
name

A name for the resource.

stringnull
description

Content in specified format.

required object
content_type
One of: plainmarkdownhtml
required string
value

The content value.

required string
logo_url

A URL

stringnull[uri]
settings
object
max_members
integer
invitation
required object
enabled
required boolean
display_name

An alternative name for the organization to use on the invitation page

string
description

An alternative description of the organization to use on the invitation page

object
content_type
One of: plainmarkdownhtml
required string
value

The content value.

required string
website_url

A URL

string[uri]
org_type
One of: businesscharitypublic_sectordefault
string
address
required objectnull
line1
string
line2
string
city
string
state
string
postal_code
string
country

ISO-3166-1 alpha-3 country code (e.g. USA, CAN, GBR)

required string
business_details
object
company_number

Company number of the organization

string
sector

Sector/industry of the organization

string
tax_id

UTR in the UK, SSN in the US, etc.

string
vat_number

VAT number in the UK/EEA/EU, GST number in Canada/Singapore, etc.

string
charity_number

Charity number if the organization is a charity

string
legal_name

Legal name of the organization

string
legal_form

Legal form of the organization (e.g. 'LLC' in the US, 'Ltd' in the UK, etc.)

string
registration_date

Date of registration of the organization. In ISO 8601 format.

string
registration_country

ISO-3166-1 alpha-3 country code (e.g. USA, CAN, GBR)

string
registration_state

State of registration of the organization

string
registered_address

Registered address of the organization

required object
line1
string
line2
string
city
string
state
string
postal_code
string
country

ISO-3166-1 alpha-3 country code (e.g. USA, CAN, GBR)

required string
contact
object
email
string[email]
phone

Phone number in international format

string
website_url

A URL

string[uri]
custom_fields

Organization custom fields will be inherited by all members in the organization

object
metadata
objectnull

Responses

200

Organization updated

400

Bad request - The request is not valid or missing required parameters.

401

Unauthorized - The request is not allowed because the client or user is not authenticated.

403

Forbidden - The request is not allowed because the client or user does not have the necessary permissions.

404

Not found - The requested resource does not exist.

422

Unprocessable entity - The data provided in the request is not valid.

429

Too many requests - The client has sent too many requests in a given amount of time.

500

Internal server error - An unexpected error occurred while processing the request.