Update Company

Replace a company with the supplied fields.

Read Get Company first and preserve all values that should remain on the company record.

Behaviour

Required fields and supplied arrays are authoritative: omit an optional array to clear it.

currency must be configured for your customer.

Requires the companies:write scope.

put

Authorizations

AuthorizationstringRequired

API key sent as a bearer token (mk_live_… / mk_test_…).

Path parameters

companyIdstringRequiredPattern: ^COMP-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

Data schema used by Create Company (POST /v1/companies). Read that operation for usage, permissions and update rules. Required fields and allowed values are defined below; request and response shapes can differ.

statusstring · enumRequiredPossible values:

companyNamestring · min: 1 · max: 255Required

currencystring · min: 1 · max: 255Required

emailstring · min: 1 · max: 255Optional

workNumberstring · min: 1 · max: 255Optional

accountManagerIdstringOptionalPattern: ^USER-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

tagsstring[] · max: 50Optional

Up to 50 tags.

paymentTermsstring · min: 1 · max: 255Optional

Responses

200

Successful response.

application/json

400

Invalid request data.

application/json

401

Missing or invalid API key.

application/json

403

The API key lacks the required scope (scope_denied), or the operation is not permitted for this account (operation_not_permitted).

application/json

404

Resource not found.

application/json

422

Unprocessable entity (e.g. an unconfigured currency or quotation stage).

application/json

429

The API key exceeded its request rate (rate_limit_exceeded) or its monthly quota (quota_exceeded). Both carry Retry-After; the RateLimit-* headers accompany rate_limit_exceeded only, since a spent quota says nothing about the bucket.

application/json

500

Internal server error.

application/json

put/v1/companies/{companyId}

PUT /v1/companies/{companyId} HTTP/1.1
Host: admin.mimeeqapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 431

{
  "status": "ACTIVE",
  "companyName": "text",
  "currency": "text",
  "address": {
    "street": "text",
    "city": "text",
    "postcode": "text",
    "country": "text"
  },
  "email": "text",
  "workNumber": "text",
  "accountManagerId": "text",
  "tags": [
    "text"
  ],
  "paymentTerms": "text",
  "deliveryAddresses": [
    {
      "id": "text",
      "name": "text",
      "street": "text",
      "postcode": "text",
      "country": "text",
      "companyName": "text",
      "city": "text"
    }
  ],
  "socials": [
    {
      "id": "text",
      "type": "facebook",
      "address": "text"
    }
  ]
}

{
  "data": {
    "companyId": "COMP-123e4567-e89b-12d3-a456-426614174000",
    "companyNumericId": 1,
    "status": "ACTIVE",
    "companyName": "text",
    "currency": "text",
    "address": {
      "street": "text",
      "city": "text",
      "postcode": "text",
      "country": "text"
    },
    "email": "text",
    "workNumber": "text",
    "accountManagerId": "text",
    "accountManager": "text",
    "tags": [
      "text"
    ],
    "paymentTerms": "text",
    "deliveryAddresses": [
      {
        "id": "text",
        "name": "text",
        "street": "text",
        "postcode": "text",
        "country": "text",
        "companyName": "text",
        "city": "text"
      }
    ],
    "socials": [
      {
        "id": "text",
        "type": "facebook",
        "address": "text"
      }
    ],
    "contacts": [
      {
        "contactId": "text",
        "firstName": "text",
        "lastName": "text"
      }
    ],
    "priceLists": [
      {
        "priceListId": "text",
        "priceListName": "text",
        "status": "text"
      }
    ],
    "createdAt": "text",
    "modifiedAt": "text"
  }
}