Sign in
Company

Create company

post/v1/companies

Request body

idinteger
departmentIdinteger
namestring required
codestring nullable
emailstring nullable
phonestring nullable

Phone number of the company, with country code, without leading + (plus) sign

webstring nullable

Website domain of the company

countryCodestring nullable

ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>

statestring nullable
citystring nullable
townstring nullable
zipstring nullable
addressstring nullable
createdUserIdinteger
createdDatestring date-time nullable
updatedUserIdinteger
updatedDatestring date-time nullable
customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

photoUrlstring nullable

Company logo URL

Example request

{
  "name": "Acme Inc",
  "email": "info@acmeinc.com",
  "phone": "12124567890",
  "web": "acmeinc.com",
  "countryCode": "US"
}

Response

Created

idinteger
departmentIdinteger
namestring required
codestring nullable
emailstring nullable
phonestring nullable

Phone number of the company, with country code, without leading + (plus) sign

webstring nullable

Website domain of the company

countryCodestring nullable

ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>

statestring nullable
citystring nullable
townstring nullable
zipstring nullable
addressstring nullable
createdUserIdinteger
createdDatestring date-time nullable
updatedUserIdinteger
updatedDatestring date-time nullable
customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

photoUrlstring nullable

Company logo URL

Example response

{
  "name": "Acme Inc",
  "email": "info@acmeinc.com",
  "phone": "12124567890",
  "web": "acmeinc.com",
  "countryCode": "US"
}

Changes

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