Update organization

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Requester-Organization-ID

string<uuid>

required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

Target-Organization-ID

string<uuid>

required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Path Parameters

org_id

string<uuid>

required

Body

application/json

name

string

required

Public organization name

Required string length: 1 - 300

string<email>

required

Valid contact organization email address

Required string length: 1 - 100

established_date

string<date>

required

Date when the organization was established (must be in the past)

size_id

string<uuid>

required

Identifier of the organization size

role_id

string<uuid>

required

Identifier of the organization role

naics_code_id

string<uuid>

required

Identifier of the organization NAICS code

address

string

required

Valid organization's street address

Required string length: 1 - 500

city

string

required

Valid organization's city

Required string length: 1 - 100

state

string

required

Valid organization's state or province

Required string length: 1 - 100

postal_code

string

required

Valid organization's postal code

Required string length: 1 - 30

country_code

string

required

Valid organization's country code in ISO 3166-1 alpha-2

Required string length: 2

website

string<uri>

required

Valid organization's website URL

Required string length: 1 - 255

company_registration_number

string

required

Valid organization's company registration number

Required string length: 1 - 255

tax_id

string

required

Valid organization's tax identification number

Required string length: 1 - 255

corporation_type_id

string

required

Identifier of the organization's type of corporation

Required string length: 10 - 100

phone

string | null

Valid contact organization phone number

Example:

"+15551234567"

Response

Successful Response

name

string

required

Public organization name

Required string length: 1 - 300

string<email>

required

Valid contact organization email address

Required string length: 1 - 100

established_date

string<date>

required

Date when the organization was established (must be in the past)

size_id

string<uuid>

required

Identifier of the organization size

role_id

string<uuid>

required

Identifier of the organization role

naics_code_id

string<uuid>

required

Identifier of the organization NAICS code

address

string

required

Valid organization's street address

Required string length: 1 - 500

city

string

required

Valid organization's city

Required string length: 1 - 100

state

string

required

Valid organization's state or province

Required string length: 1 - 100

postal_code

string

required

Valid organization's postal code

Required string length: 1 - 30

country_code

string

required

Valid organization's country code in ISO 3166-1 alpha-2

Required string length: 2

website

string<uri>

required

Valid organization's website URL

Required string length: 1 - 255

company_registration_number

string

required

Valid organization's company registration number

Required string length: 1 - 255

tax_id

string

required

Valid organization's tax identification number

Required string length: 1 - 255

corporation_type_id

string

required

Identifier of the organization's type of corporation

Required string length: 10 - 100

currency_code

string

required

Valid organization's currency code in ISO 4217

Required string length: 3

string<uuid>

required

Unique identifier of the organization

owner_account_id

string<uuid>

required

Unique identifier of the organization's owner account

status

enum<string>

required

Organization status

Available options:

active,

deleted

created_at

string<date-time>

required

Date and time when the organization was created

updated_at

string<date-time>

required

Date and time of the last update of public information about the organization.

phone

string | null

Valid contact organization phone number

Example:

"+15551234567"

Introduction

API Reference (v1)

Authorizations

Headers

Path Parameters

Body

Response