Companies

Create a company

post/companies

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/companies
  • Auth: HTTP bearer

Request body

namestring required

The name of the company. Max 255 characters.

isActiveboolean

Whether the company is active.

descriptionstring

A description of the company. Max 5000 characters.

billingAddressstring

The billing address of the company. Max 5000 characters.

currencystring

The three-letter currency code for the company. Defaults to the workspace currency if not provided.

facebookUrlstring

The company's Facebook URL. Max 1024 characters.

linkedinUrlstring

The company's LinkedIn URL. Max 1024 characters.

twitterUrlstring

The company's Twitter URL. Max 1024 characters.

websiteUrlstring

The company's website URL. Max 1024 characters.

numberOfEmployeesinteger

The number of employees.

ownershipClass'public' | 'private' | 'subsidiary' | 'other' | 'null' nullable

The ownership class. Can be: "public" (Public), "private" (Private), "subsidiary" (Subsidiary), or "other" (Other).

phoneNumberstring

The phone number of the company. Max 255 characters.

revenuenumber

The annual revenue of the company.

shippingAddressstring

The shipping address of the company. Max 5000 characters.

tickerSymbolstring

The stock ticker symbol for the company. Max 10 characters.

yearFoundedinteger

The year the company was founded.

companySpendTierIdstring

The company spend tier ID (uuid) of the company spend tier associated with this company.

companyTypeIdstring

The company type ID (uuid) of the company type associated with this company.

practiceIdstring

The practice ID (uuid) of the practice associated with this company.

businessUnitIdstring nullable

The business unit ID (uuid) of the business unit associated with this company.

industryIdstring

The industry ID (uuid) of the industry associated with this company.

ownerIdstring

The member ID (uuid) of the owner of this company.

sicCodeIdstring

The SIC code ID (uuid) of the SIC code associated with this company.

timeZoneIdstring

The time zone ID (uuid) of the time zone associated with this company.

Response

200

idstring

The unique identifier for the object.

namestring nullable

The name of the company.

isActiveboolean

Whether the company is active.

descriptionstring nullable

A description of the company.

billingAddressstring nullable

The billing address of the company.

currencystring

The three-letter currency code for the company.

facebookUrlstring nullable

The company's Facebook URL.

linkedinUrlstring nullable

The company's LinkedIn URL.

twitterUrlstring nullable

The company's Twitter URL.

websiteUrlstring nullable

The company's website URL.

numberOfEmployeesinteger nullable

The number of employees.

ownershipClass'public' | 'private' | 'subsidiary' | 'other' | 'null' nullable

The ownership classification of the company.

phoneNumberstring nullable

The phone number of the company.

revenuenumber nullable

The annual revenue of the company.

shippingAddressstring nullable

The shipping address of the company.

tickerSymbolstring nullable

The stock ticker symbol for the company.

yearFoundedinteger nullable

The year the company was founded.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

salesforceIdstring nullable

The Salesforce record ID for this company, if synced via Salesforce integration.

hubspotIdstring nullable

The HubSpot record ID for this company, if synced via HubSpot integration.

Changes

No recorded changes to this operation across all 1 revision of this API.