Sign in

v1

latestOpenAPI 3.1.02026-07-247328324.6 KB
Core resources

Update an organization

patch/organizations/{id}

Path parameters

idstring required

An object id with prefix

Example:user_0123456789ABCDEFGHIJKLMNOPq

An object id with prefix

Headers

if-matchstring date-time required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Example:2024-01-15T10:30:00Z

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Request body

namestring

Non-empty text string

websitestring nullable

The website address of the business

linkedinstring uri nullable

The linked-in url of the business

legal_structure'sole_proprietor' | 'single_member_llc' | 'limited_liability_company' | 'general_partnership' | 'unlisted_corporation' | 'publicly_traded_corporation' | 'association' | 'non_profit' | 'government_organization' | 'revocable_trust' | 'irrevocable_trust' | 'estate' | 'null' nullable

The legal structure of the business

industrystring nullable

The industry of the business

formation_datestring date nullable

The formation date of the business

size'1-24' | '25-99' | '100-499' | '500+' | 'null' nullable

The size of the business based on number of employees or contractors

{"stackTrail":"paths:/organizations/{id}:patch:requestBody:content:application/json:schema:properties:yc_verified","oasType":"schema","type":"unknown","description":"clear yc_verified flag"}
advance_for'me' | 'my_users' | 'null' nullable

Whether the organization is using advances for retail customers ("me") or as a platform for others ("my_users")

aiprise_business_idstring nullable

The kyb verification session id

monato_business_idstring nullable

The monato business id

yc_urlstring nullable

the y combinator verification url

Example request

{
  "website": "https://acme.com",
  "linkedin": "https://www.acme.com",
  "industry": "541511",
  "formation_date": "2024-01-15"
}

Response

Successful operation

namestring required

Non-empty text string

websitestring

The website address of the business

linkedinstring uri

The linked-in url of the business

legal_structure'sole_proprietor' | 'single_member_llc' | 'limited_liability_company' | 'general_partnership' | 'unlisted_corporation' | 'publicly_traded_corporation' | 'association' | 'non_profit' | 'government_organization' | 'revocable_trust' | 'irrevocable_trust' | 'estate'

The legal structure of the business

industrystring

The industry of the business

formation_datestring date

The formation date of the business

size'1-24' | '25-99' | '100-499' | '500+'

The size of the business based on number of employees or contractors

yc_verifiedstring date

date on which YC url was verified

advance_for'me' | 'my_users' | 'null' nullable

Whether the organization is using advances for retail customers ("me") or as a platform for others ("my_users")

aiprise_business_idstring nullable

The kyb verification session id

monato_business_idstring nullable

The monato business id

picturestring uri required

The business logo

idstring required

An object id with prefix

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

Example response

{
  "website": "https://acme.com",
  "linkedin": "https://www.acme.com",
  "industry": "541511",
  "formation_date": "2024-01-15",
  "yc_verified": "2024-01-15",
  "picture": "https://www.acme.com",
  "id": "user_0123456789ABCDEFGHIJKLMNOPq",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}