Skip to main content
MUTATION
companiesAdd(avatar: String, primaryName: String, names: [String], primaryPhone: String, phones: [String], primaryEmail: String, emails: [String], primaryAddress: JSON, addresses: [JSON], size: Int, website: String, industry: String, parentCompanyId: String, email: String, ownerId: String, businessType: String, description: String, isSubscribed: String, links: JSON, tagIds: [String], customFieldsData: JSON, code: String, location: String): Company

Arguments

avatar
String

Logo/avatar image URL.

primaryName
String

Main display name.

names
[String]

Additional known names.

primaryPhone
String

Main phone number, used for identity matching.

phones
[String]

Additional known phone numbers.

primaryEmail
String

Main email address, used for identity matching.

emails
[String]

Additional known email addresses.

primaryAddress
JSON

Primary address as free-form JSON.

addresses
[JSON]

Additional addresses as free-form JSON.

size
Int

Approximate headcount.

website
String

Company website URL.

industry
String

Industry classification (free text).

parentCompanyId
String

Id of the parent Company in a hierarchy, if any.

email
String

Legacy single email field. Prefer primaryEmail / emails — kept for backward compatibility only.

ownerId
String

Id of the User to assign as owner.

businessType
String

Business type classification (free text).

description
String

Free-form notes.

isSubscribed
String

Marketing consent flag, e.g. "Yes" / "No".

links
JSON

Social/external profile links as free-form JSON.

tagIds
[String]

Ids of Tag records to attach at creation.

customFieldsData
JSON

Custom field values as an array of { field, value } entries.

code
String

Optional short human-friendly identifier.

location
String

Free-text location label.

Returns

Company
createdAt
Date

When this record was created.

modifiedAt
Date

When this record was last updated.

avatar
String

Logo/avatar image URL.

size
Int

Approximate headcount.

website
String

Company website URL.

industry
String

Industry classification (free text).

plan
String

Subscription plan label for this account, if tracked.

parentCompanyId
String

Id of the parent Company in a hierarchy, if any.

ownerId
String

Id of the User assigned as owner of this company.

mergedIds
[String]

Ids of companies previously absorbed into this one via companiesMerge.

names
[String]

All known names for this company.

primaryName
String

Main display name.

emails
[String]

All known email addresses.

primaryEmail
String

Main email address, used for identity matching.

phones
[String]

All known phone numbers.

primaryPhone
String

Main phone number, used for identity matching.

primaryAddress
JSON

Primary mailing address as free-form JSON.

addresses
[JSON]

All known addresses as free-form JSON.

businessType
String

Business type classification (free text).

description
String

Free-form notes about this company.

isSubscribed
String

Subscription/marketing consent flag, e.g. "Yes" / "No".

links
JSON

Social/external profile links as free-form JSON.

owner
User

Resolved User for ownerId.

parentCompany
Company

Resolved parent Company for parentCompanyId.

tagIds
[String]

Ids of Tag records attached to this company. See companies's tag filter.

customFieldsData
JSON

Custom field values as an array of { field, value } entries.

customFieldsDataByFieldCode
JSON

Custom field values keyed by field code instead of field id.

customers
[Customer]

Customer records related to this company via conformity.

getTags
[Tag]

Resolved Tag objects for tagIds.

code
String

Short human-friendly identifier. Accepted anywhere _id is accepted on lookups such as companyDetail.

location
String

Free-text location label.

score
Float

Engagement/lead score, when scoring is enabled for this workspace.

_id
String!
Mutation
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦