Skip to main content
PATCH
/
company
/
{id}
Update company
curl --request PATCH \
  --url https://api.instaview.sk/company/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Corporation",
  "description": "Leading technology company specializing in enterprise software",
  "metadata": {
    "industry": "Technology",
    "size": "50-200"
  },
  "ownerEmail": "owner@example.com"
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "createdAt": "2024-11-16T10:30:00Z",
  "updatedAt": "2024-11-16T10:30:00Z",
  "description": "Leading technology company",
  "ownerEmail": "owner@example.com",
  "metadata": {
    "externalCompanyId": "COMP-12345",
    "industry": "Technology"
  }
}
Updates an existing company using partial updates. Access rules differ between regular API keys and ATS integration keys.

​
Overview

The update company endpoint allows you to modify company information without recreating it. This supports partial updates, meaning you only need to provide the fields you want to change. Regular API keys can update their own company, while ATS keys can update companies they’ve created.

​
Access Rules

​
Regular API Keys

Regular API keys can only update their associated company: 
// ✅ Can update own company
PATCH /company/{own-company-id}
{
  "name": "Updated Company Name"
}

​
ATS Integration Keys

ATS keys can update any company they’ve created: 
// ✅ Can update companies created by this ATS key
PATCH /company/{ats-managed-company-id}
{
  "name": "Updated Client Company Name"
}

​
Use Cases

  • Company Profile Updates: Update company name, website, or industry
  • Settings Management: Modify company settings (timezone, locale)
  • Client Management: Update client company information for ATS platforms

​
Partial Updates

You can update any combination of fields: 
// Update only name
PATCH /company/{id}
{
  "name": "New Company Name"
}

// Update multiple fields
PATCH /company/{id}
{
  "name": "Updated Name",
  "website": "https://newwebsite.com",
  "industry": "Technology"
}

​
Error Scenarios

  • 404 Not Found: Company doesn’t exist
  • 403 Forbidden: Company is not accessible or updatable with your API key type
  • 400 Bad Request: Invalid field values or validation errors

ATS Integration Guide

Learn about ATS integration keys

Companies Resource Guide

Understand company management

Get Company

Retrieve current company information

Authorizations

​
Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Body

application/json
​
name
string

Company name

Required string length: 2 - 100
Example:

"Acme Corporation"

​
description
string

Company description

Required string length: 1 - 1000
Example:

"Leading technology company specializing in enterprise software"

​
metadata
object

Custom metadata (merged with existing metadata, max 10KB, 5 levels deep, 50 keys)

Example:
{
  "industry": "Technology",
  "size": "50-200"
}
​
ownerEmail
string<email>

Email of the company owner. If provided, the system will automatically assign or invite the user.

Maximum string length: 254
Example:

"owner@example.com"

Response

200 - application/json
​
id
string
required

Company ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Company name

Example:

"Acme Corporation"

​
createdAt
string
required

Created timestamp

Example:

"2024-11-16T10:30:00Z"

​
updatedAt
string
required

Updated timestamp

Example:

"2024-11-16T10:30:00Z"

​
description
string

Company description

Example:

"Leading technology company"

​
ownerEmail
string<email>

Email of the company owner

Maximum string length: 254
Example:

"owner@example.com"

​
metadata
object

Custom metadata

Example:
{
  "externalCompanyId": "COMP-12345",
  "industry": "Technology"
}