Update Company by lookup key

PATCH 
/companies/:lookupKey/:lookupValue

Use this endpoint to update company by lookup key. If multiple companies with the same lookup key exist, use additional filtering depending on the lookup key to uniquely identify the company (e.g. source and language for lookup key sourceId).

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about company lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

application/json

Body

budget string
budgetInherit string
cocNumber string
company string
debtorId string
department string
inheritOrderList string
inheritProductList string
name string
notes string
office string

parent

object

id number
taxNumber string

Responses

200

Update Company by lookup key - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

budget string

budgetInherit string

cocNumber string

debtorId string

department string

id number

inheritOrderList string

inheritProductList string

name string

notes string

office string

parent

object

id number

taxNumber string
messages string[]
total number

Example (from schema)

{
  "data": {
    "budget": "N",
    "budgetInherit": "N",
    "cocNumber": "75564998",
    "debtorId": "75564998",
    "department": "",
    "id": 9482,
    "inheritOrderList": "N",
    "inheritProductList": "Y",
    "name": "Propellor B.V.",
    "notes": "Company created from API",
    "office": "",
    "parent": {
      "id": 106
    },
    "taxNumber": "NL860325386B01"
  },
  "messages": [
    "Company updated"
  ],
  "total": 1
}

Update Company by lookup key - 200

{
  "data": {
    "budget": "N",
    "budgetInherit": "N",
    "cocNumber": "75564998",
    "debtorId": "75564998",
    "department": "",
    "id": 9482,
    "inheritOrderList": "N",
    "inheritProductList": "Y",
    "name": "Propellor B.V.",
    "notes": "Company created from API",
    "office": "",
    "parent": {
      "id": 106
    },
    "taxNumber": "NL860325386B01"
  },
  "messages": [
    "Company updated"
  ],
  "total": 1
}

400

Update Company by lookup key - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Update Company by lookup key - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [company] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Update Company by lookup key - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 40006,
    "messages": [
      "Company with id [9484] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/40006",
    "status": 404,
    "type": "CompanyNotFound"
  }
}

Update Company by lookup key - 404

{
  "error": {
    "code": 40006,
    "messages": [
      "Company with id [9484] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/40006",
    "status": 404,
    "type": "CompanyNotFound"
  }
}

Loading...