Create company

GraphQL endpoint: /user

Creates a new company profile as a user, registering the business on the platform. Requires a legal name and a unique profile name; optionally accepts brand name, tax IDs, contact information (emails, telephone numbers, addresses), online presence (webpages, social networks), trusted domains, subscription topics and settings, industry classification, visibility settings, and metadata. Setting provisionCompanyClientSecret creates API credentials on company creation. The user creating the company is automatically connected with the given connectionType (OWNER, ADMIN or EXTERNAL_ADMIN).

Query

mutation (
  $legalName: String!
  $brandName: String
  $profileName: String!
  $yearFounded: Int
  $aboutUs: String
  $metadata: JSON
  $emails: [CompanyEmailInput!]
  $telephoneNumbers: [CompanyTelephoneNumberInput!]
  $addresses: [CompanyAddressInput!]
  $webpages: [CompanyWebpageInput!]
  $socialNetworks: [CompanySocialMediaInput!]
  $trustedDomains: [TrustedDomainInput!]
  $subscriptionTopics: [B2cSubscriptionTopicInput!]
  $subscriptionSettings: CompanySubscriptionSettingsInput
  $taxIds: [CompanyTaxIdInput!]
  $verticalTypeId: ID
  $organizationTypeId: ID
  $companySpecialties: [ID]
  $legalNameVisibility: [CompanyVisibilityType!]
  $brandNameVisibility: [CompanyVisibilityType!]
  $logoUrlVisibility: [CompanyVisibilityType!]
  $aboutUsVisibility: [CompanyVisibilityType!]
  $yearFoundedVisibility: [CompanyVisibilityType!]
  $verticalTypeVisibility: [CompanyVisibilityType!]
  $organizationTypeVisibility: [CompanyVisibilityType!]
  $specialtiesVisibility: [CompanyVisibilityType!]
  $b2cVisibility: [CompanyVisibilityType!]
  $metadataVisibility: [CompanyVisibilityType!]
  $provisionCompanyClientSecret: Boolean
  $connectionType: AdminB2cConnectionType
) {
  createCompany (
    legalName: $legalName
    brandName: $brandName
    profileName: $profileName
    yearFounded: $yearFounded
    aboutUs: $aboutUs
    metadata: $metadata
    emails: $emails
    telephoneNumbers: $telephoneNumbers
    addresses: $addresses
    webpages: $webpages
    socialNetworks: $socialNetworks
    trustedDomains: $trustedDomains
    subscriptionTopics: $subscriptionTopics
    subscriptionSettings: $subscriptionSettings
    taxIds: $taxIds
    verticalTypeId: $verticalTypeId
    organizationTypeId: $organizationTypeId
    companySpecialties: $companySpecialties
    legalNameVisibility: $legalNameVisibility
    brandNameVisibility: $brandNameVisibility
    logoUrlVisibility: $logoUrlVisibility
    aboutUsVisibility: $aboutUsVisibility
    yearFoundedVisibility: $yearFoundedVisibility
    verticalTypeVisibility: $verticalTypeVisibility
    organizationTypeVisibility: $organizationTypeVisibility
    specialtiesVisibility: $specialtiesVisibility
    b2cVisibility: $b2cVisibility
    metadataVisibility: $metadataVisibility
    provisionCompanyClientSecret: $provisionCompanyClientSecret
    connectionType: $connectionType
  ) {
    id
    clientSecret {
    clientId
    clientSecret
    description
    }
  }
}

Variables

{
  "aboutUs": "about us content",
  "aboutUsVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "addresses": [
    {
      "city": "test city",
      "country": "United States",
      "state": "Alabama",
      "street": "test street 3",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ],
      "zipCode": "12345"
    },
    {
      "city": "test city",
      "country": "United States",
      "state": "Alabama",
      "street": "test street 4",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ],
      "zipCode": "12345"
    }
  ],
  "b2cVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "brandName": "2brand-name",
  "brandNameVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "companySpecialties": [
    "00000000-0000-4000-8000-000000000005"
  ],
  "emails": [
    {
      "email": "[e-mail]",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    },
    {
      "email": "[e-mail]",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    }
  ],
  "legalName": "1legal-name",
  "legalNameVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "logoUrlVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "metadata": {
    "test": "value"
  },
  "metadataVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "organizationTypeId": "00000000-0000-4000-8000-000000000004",
  "organizationTypeVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "profileName": "3profile-name",
  "provisionCompanyClientSecret": true,
  "socialNetworks": [
    {
      "type": "FACEBOOK",
      "url": "https://test-sm9.not",
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    },
    {
      "type": "FACEBOOK",
      "url": "https://test-sm10.not",
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    }
  ],
  "specialtiesVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "subscriptionSettings": {
    "enable_email": false,
    "enable_sms": false,
    "enable_voice": false
  },
  "subscriptionTopics": [
    {
      "description": "description_12",
      "enableEmail": false,
      "enableSms": false,
      "enableVoice": false,
      "name": "topic_11",
      "type": "CRITICAL"
    },
    {
      "description": "description_14",
      "enableEmail": false,
      "enableSms": false,
      "enableVoice": false,
      "name": "topic_13",
      "type": "CRITICAL"
    }
  ],
  "taxIdVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "taxIds": [
    {
      "type": "EIN",
      "usState": null,
      "value": "100000136",
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    }
  ],
  "telephoneNumbers": [
    {
      "country_code": "1",
      "number": "7",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    },
    {
      "country_code": "1",
      "number": "8",
      "types": [
        "SUPPORT"
      ],
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    }
  ],
  "trustedDomains": [
    {
      "domain": "test123.com"
    },
    {
      "domain": "test456.com"
    }
  ],
  "verticalTypeId": "00000000-0000-4000-8000-000000000003",
  "verticalTypeVisibility": [
    "PARTNER",
    "CUSTOMER"
  ],
  "webpages": [
    {
      "type": "WEBPAGE",
      "url": "https://test-webpage5.not",
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    },
    {
      "type": "WEBPAGE",
      "url": "https://test-webpage6.not",
      "visibility": [
        "PARTNER",
        "CUSTOMER"
      ]
    }
  ],
  "yearFounded": 2000,
  "yearFoundedVisibility": [
    "PARTNER",
    "CUSTOMER"
  ]
}

Response

{
  "data": {
    "createCompany": {
      "clientSecret": {
        "clientId": "00000000-0000-4000-8000-000000000001",
        "clientSecret": "06WJQkWsVfcT5gOyCRmjdQ",
        "description": null
      },
      "id": "00000000-0000-4000-8000-000000000002"
    }
  }
}