Update a company

PATCH

/api/v1/companies/{id}

curl --request PATCH \
  --url https://digize.com/api/v1/companies/example \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "name": "example", "domain": "example", "industry": "example", "city": "example", "ownerId": "example" }'

• Digize

Changes a company’s name, website, industry, city or owner.

Needs the crm:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

name

string

<= 120 characters

domain

Any of:

string

string

<= 253 characters

null

null

industry

Any of:

string

string

<= 60 characters

null

null

city

Any of:

string

string

<= 100 characters

null

null

ownerId

Any of:

string

string

>= 1 characters <= 64 characters

null

null

Example ^generated

{
  "name": "example",
  "domain": "example",
  "industry": "example",
  "city": "example",
  "ownerId": "example"
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

name

required

string

domain

required

string | null

industry

required

string | null

city

required

string | null

ownerId

required

string | null

createdAt

required

string format: date-time

status

required

string

Allowed values: active lapsed prospect

people

required

Array<object>

object

id

required

string

name

required

string

email

required

string | null

stage

required

string

Allowed values: lead customer repeat

lifetimeValue

required

number

orders

required

number

totalSpent

required

number

lastOrderAt

required

Any of:

string

string format: date-time

null

null

recentOrders

required

Array<object>

object

id

required

string

number

required

number

customerName

required

string

placedAt

required

string format: date-time

total

required

number

Example

{
  "status": "active",
  "people": [
    {
      "stage": "lead"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}