Skip to main content
POST
/
api
/
rest
/
companies
Create company
curl --request POST \
  --url https://api.upwell.com/api/rest/companies \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "addresses": {},
    "auditLogs": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "dunsNumber": "<string>",
    "id": "<string>",
    "logoUrl": "<string>",
    "mcNumber": "<string>",
    "name": "<string>",
    "primaryEmailAddress": "<string>",
    "primaryPhone": "<string>",
    "shipments": {},
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "sourceSystemMeta": "<unknown>",
    "tenant": {},
    "tenantId": "<string>",
    "termsOfService": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "website": "<string>"
  }
}
'
{
  "createCompany": {
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "dunsNumber": "<string>",
    "id": "<string>",
    "logoUrl": "<string>",
    "mcNumber": "<string>",
    "name": "<string>",
    "primaryEmailAddress": "<string>",
    "primaryPhone": "<string>",
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "termsOfService": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "website": "<string>"
  }
}

Headers

ā€‹
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Body

application/json

Query parameters can also be provided in the request body as a JSON object

ā€‹
input
CompaniesInsertInput Ā· object

input type for inserting data into table "companies"

Response

200 - application/json

Responses for POST /api/rest/companies

ā€‹
createCompany
Companies Ā· object

Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.