New: Kith open-sources its ATS.Read why
Skip to Content
Inputs

UpdateCompanyInput

What to change on a company. A field left out is unchanged; null clears it, except for a field that cannot be empty.

input UpdateCompanyInput {
  companyId: ID!
  defaultFeeBasis: FeeBasis
  defaultFeePercent: Decimal
  defaultGuaranteeDays: Int
  linkedinUrl: String
  location: String
  logoUrl: String
  name: String
  notes: String
  ownerId: ID
  relationship: CompanyRelationship
  sector: String
  sectorTags: [String!]
  status: CompanyStatus
  website: String
}

Fields

UpdateCompanyInput.companyId · ID! non-null scalar

The company's id.

UpdateCompanyInput.defaultFeeBasis · FeeBasis enum

What that percentage is of.

UpdateCompanyInput.defaultFeePercent · Decimal scalar

The fee percentage a new opportunity starts with, from 0 to 100.

UpdateCompanyInput.defaultGuaranteeDays · Int scalar

The guarantee, in days, a new opportunity starts with. 0 or more.

UpdateCompanyInput.linkedinUrl · String scalar

The company's LinkedIn page, as an http or https address.

UpdateCompanyInput.location · String scalar

Where it is based. 10,000 characters at most.

UpdateCompanyInput.logoUrl · String scalar

A logo for the company, as a public http or https address. Null clears it.

UpdateCompanyInput.name · String scalar

The company's name, from 1 to 300 characters. It cannot be cleared.

UpdateCompanyInput.notes · String scalar

Notes about the relationship. 10,000 characters at most.

UpdateCompanyInput.ownerId · ID scalar

The member who looks after the relationship. Must be a member of this workspace.

UpdateCompanyInput.relationship · CompanyRelationship enum

What the company is to the workspace. Only a company that is already a lead or a client can change it (any other is NOT_FOUND: a company is first made a lead or a client by addCompany). A client that has a job that is not a draft cannot be made a lead (COMPANY_HAS_CLIENT_JOBS): archive it instead. It cannot be cleared.

UpdateCompanyInput.sector · String scalar

What the company does. 10,000 characters at most.

UpdateCompanyInput.sectorTags · [String!] list scalar

The workspace's sector labels for it. Replaces the list: 100 at most, each from 1 to 300 characters.

UpdateCompanyInput.status · CompanyStatus enum

Where the relationship stands. CLIENT and FORMER_CLIENT make it a client, any other makes it a lead, and none ever makes a client a lead. Only a company that is already a lead or a client can change it. It cannot be cleared.

UpdateCompanyInput.website · String scalar

The company's website, kept as https:// and its public domain. Setting it answers any website research as entered by a person. Null clears it.

Member Of

updateCompany mutation