Skip to main content
PUT
/
company
/
{company_id}
Update a company
curl --request PUT \
  --url https://api-dev.narrative.io/company/{company_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "ACM",
  "slug": "acm",
  "long_description": "The Acme Corporation is an ironic name for the fictional corporation, appearing in the Road Runner/Wile E. Coyote animated shorts, where it was used as a running gag.",
  "short_description": "American Company that Manufactures Everything",
  "contact_email": "[email protected]",
  "twitter_link": "https://twitter.com/acm_company",
  "linkedin_link": "https://www.linkedin.com/company/acm_company",
  "image_url": null,
  "visibility": "visible",
  "status": "active",
  "website": null
}
'
{
  "company_id": 42,
  "name": "ACM",
  "slug": "acm",
  "long_description": "The Acme Corporation is an ironic name for the fictional corporation, appearing in the Road Runner/Wile E. Coyote animated shorts, where it was used as a running gag.",
  "short_description": "American Company that Manufactures Everything",
  "contact_email": "[email protected]",
  "twitter_link": "https://twitter.com/acm_company",
  "linkedin_link": "https://www.linkedin.com/company/acm_company",
  "image_url": null,
  "visibility": "visible",
  "status": "active",
  "website": null,
  "created_at": "2016-06-09T02:00:47Z",
  "created_by": "[email protected]",
  "last_updated_at": "2023-08-17T16:18:10.386058Z",
  "last_updated_by": "[email protected]"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id
integer<int64>
required

The id of an existing company

Body

application/json
company_id
integer

Unique identifier of an existing company.

Example:

7

name
string

Name of the company

slug
string

Name of the company

short_description
string

A short description of the company

long_description
string

The complete description of the company

image_url
string

The url of the logo of the company

location
string

The geographical location of the company

size
string

The number of employees

website
string

The url of the website of the company

contact_email
string

Email contact

Twitter account

LinkedIn account

visibility
enum<string>
Available options:
invisible,
visible,
invisible_in_discover
status
enum<string>
Available options:
active,
deleted,
pending

Response

200 - application/json

OK

company_id
integer

Unique identifier of an existing company.

Example:

7

name
string

Name of the company

slug
string

Unique id for the company

short_description
string

A short description of the company

long_description
string

The complete description of the company

image_url
string

The url of the logo of the company

location
string

The geographical location of the company

size
string

The number of employees

website
string

The url of the website of the company

contact_email
string

Email contact

Twitter account

LinkedIn account

created_at
string

The instant this company was created.

Example:

"2021-06-24T00:54:40.029056Z"

created_by
string

Contact of user who created the company

last_updated_at
string

The instant this company was created.

Example:

"2021-06-24T00:54:40.029056Z"

last_updated_by
string

Contact of user who updated the company

visibility
enum<string>
Available options:
invisible,
visible,
invisible_in_discover
status
enum<string>
Available options:
active,
deleted,
pending