Company

patch

https://api.marketcircle.net/v1/companies/{id}

Edit a Company

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This function allows you to modify an existing company. See Company attributes for a list of attributes which are supported for companies. Only attributes marked as Read-Write can be set using this endpoint.

📘
Note
When editing a contact, including the add or remove actions will allow you to specify a list of items to update/remove from the field's existing contents. Leaving out add or remove will replace the fields contents entirely.
Examples:
{ "keywords": { "add":["test"] } }
{ "keywords": { "remove":["test"] } }

Path Params

int32

required

The company identifier.

Body Params

name

string

Name

number_of_employees

string

number of employees

flagged

string

company is flagged

tagline

string

Tagline for the company

ticker_symbol

string

Ticker Symbol for the company

sic_code

string

image

string

Imaged reference Company Image Example: /v1/companies/1001/image

category

string

Category name

keywords

List of Keywords Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

extra_fields

object

Each extra field will use its default name even if you have customized it

type

string

A Company Type name

industry

string

Industry name

region

string

Region name

emails

List of E-mail addresses Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

urls

List of URLs Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

social_profiles

List of Social Profiles Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

phone_numbers

List of Phone Numbers Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

addresses

List of Addresses Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

details

string

Additional misc. notes or details about the company

contacts

List of Contact Roles Example: /v1/contacts/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

List of Opportunities Example: /v1/opportunities/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

List of Projects Example: /v1/projects/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

List of Company Roles Example: /v1/companies/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

appointments

List of Appointments Example: /v1/appointments/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

List of Forms Example: /v1/forms/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

List of Notes Example: /v1/notes/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

List of Tasks Example: /v1/tasks/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

List of Groups Example: /v1/groups/1001 Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

owner

string

URL of the User that is responsible for the company

trashed

boolean

You can use this to untrash an object by setting it to false. true will do nothing, use delete for that.

Responses

Note

200200

400400