---
title: "Retrieve or update a company shell"
method: PUT
path: "/api/v0/company_shells/{id}"
tags: ["Company shells"]
---

# Retrieve or update a company shell

`PUT /api/v0/company_shells/{id}`

## Request

- Base URL: `https://www.getonbrd.com`
- URL: `https://www.getonbrd.com/api/v0/company_shells/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/getonbrd/apis/get-on-board-api/docs/api/v0/company_shells/:id/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required

## Request body

- object
  - `company_shell` object, required
    - `description` string, required
    - `name` string
    - `web` string

## Response `200`

Reads or updates one partner-owned company shell by slug. Updatable fields are `name`, `description`, and `web`; a logo is required on create (multipart `logo` or `remote_logo_url`), where `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.

- object
  - `data` object, required
    - `id` string, required
    - `type` string, required
    - `attributes` object, required
      - `name` string, required
      - `description` string, required
      - `web` string, required
      - `logo` string, required

## Other responses

- `403`: Reads or updates one partner-owned company shell by slug. Updatable fields are `name`, `description`, and `web`; a logo is required on create (multipart `logo` or `remote_logo_url`), where `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.
- `404`: Reads or updates one partner-owned company shell by slug. Updatable fields are `name`, `description`, and `web`; a logo is required on create (multipart `logo` or `remote_logo_url`), where `remote_logo_url` must be a publicly reachable https URL — private or internal hosts are rejected with `could not download logo`. Partner-only: requires an authorized partner account; standard company API keys receive 403.

---

[API](https://skmtc.dev/getonbrd/apis/get-on-board-api.md) - [All operations](https://skmtc.dev/getonbrd/apis/get-on-board-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getonbrd/apis/get-on-board-api/revisions/f8405113049f?raw)