kustomer-client
    Preparing search index...

    Type Alias CreateCompanyData

    type CreateCompanyData = {
        body?: {
            avatarUrl?: string | null;
            createdAt?: string;
            custom?: { [key: string]: never };
            defaultLang?: string | null;
            domains?: { domain: string }[];
            emails?: {
                email: string;
                type?: "home" | "work" | "other";
                verified?: boolean;
            }[];
            employeeCount?: number;
            externalId?: string;
            importedAt?: string;
            locations?: {
                address?: string
                | null;
                address2?: string | null;
                address3?: string | null;
                areaCode?: string | null;
                cityName?: string | null;
                countryCode?: string | null;
                countryName?: string | null;
                latitude?: number | null;
                longitude?: number | null;
                name?: string | null;
                regionCode?: string | null;
                regionName?: string | null;
                type?: "home" | "work" | "other";
                zipCode?: string | null;
            }[];
            name: string;
            phones?: {
                phone: string;
                type?: "mobile"
                | "home"
                | "work"
                | "fax"
                | "other";
                verified?: boolean;
            }[];
            rev?: number;
            socials?: {
                type: "twitter"
                | "facebook"
                | "instagram"
                | "linkedin"
                | "pinterest";
                url?: string;
                userid?: string;
                username: string;
                verified?: boolean;
            }[];
            tags?: string[];
            urls?: { type?: "website"
            | "blog"
            | "other"; url: string }[];
            whatsapps?: { phone: string; type?: "mobile"; verified?: boolean }[];
        };
        path?: never;
        query?: never;
        url: "/companies";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: {
        avatarUrl?: string | null;
        createdAt?: string;
        custom?: { [key: string]: never };
        defaultLang?: string | null;
        domains?: { domain: string }[];
        emails?: {
            email: string;
            type?: "home" | "work" | "other";
            verified?: boolean;
        }[];
        employeeCount?: number;
        externalId?: string;
        importedAt?: string;
        locations?: {
            address?: string
            | null;
            address2?: string | null;
            address3?: string | null;
            areaCode?: string | null;
            cityName?: string | null;
            countryCode?: string | null;
            countryName?: string | null;
            latitude?: number | null;
            longitude?: number | null;
            name?: string | null;
            regionCode?: string | null;
            regionName?: string | null;
            type?: "home" | "work" | "other";
            zipCode?: string | null;
        }[];
        name: string;
        phones?: {
            phone: string;
            type?: "mobile"
            | "home"
            | "work"
            | "fax"
            | "other";
            verified?: boolean;
        }[];
        rev?: number;
        socials?: {
            type: "twitter"
            | "facebook"
            | "instagram"
            | "linkedin"
            | "pinterest";
            url?: string;
            userid?: string;
            username: string;
            verified?: boolean;
        }[];
        tags?: string[];
        urls?: { type?: "website"
        | "blog"
        | "other"; url: string }[];
        whatsapps?: { phone: string; type?: "mobile"; verified?: boolean }[];
    }

    Type declaration

    • OptionalavatarUrl?: string | null

      The URL for the avatar image of this company.

    • OptionalcreatedAt?: string

      The date and time the company object was created in Kustomer.

    • Optionalcustom?: { [key: string]: never }
    • OptionaldefaultLang?: string | null
    • Optionaldomains?: { domain: string }[]
    • Optionalemails?: { email: string; type?: "home" | "work" | "other"; verified?: boolean }[]

      The email addresses associated with this company. The maximum amount is 10.

    • OptionalemployeeCount?: number

      The number of customers associated with this company.

    • OptionalexternalId?: string

      The third party application ID for this company, if applicable. The maximum length is 256.

    • OptionalimportedAt?: string

      The date and time the company was imported from an external system.

    • Optionallocations?: {
          address?: string | null;
          address2?: string | null;
          address3?: string | null;
          areaCode?: string | null;
          cityName?: string | null;
          countryCode?: string | null;
          countryName?: string | null;
          latitude?: number | null;
          longitude?: number | null;
          name?: string | null;
          regionCode?: string | null;
          regionName?: string | null;
          type?: "home" | "work" | "other";
          zipCode?: string | null;
      }[]

      The primary address associated with this company. The maximum amount is 10.

    • name: string

      The name of the company. The minimum length is 3 and the maximum is 255.

    • Optionalphones?: {
          phone: string;
          type?: "mobile" | "home" | "work" | "fax" | "other";
          verified?: boolean;
      }[]

      The phone numbers associated with this company. The maximum amount is 10.

    • Optionalrev?: number
    • Optionalsocials?: {
          type: "twitter" | "facebook" | "instagram" | "linkedin" | "pinterest";
          url?: string;
          userid?: string;
          username: string;
          verified?: boolean;
      }[]

      The social media handles associated with this company. The maximum amount of items is 10.

    • Optionaltags?: string[]
    • Optionalurls?: { type?: "website" | "blog" | "other"; url: string }[]

      The websites associated with this company. The maximum amount is 10.

    • Optionalwhatsapps?: { phone: string; type?: "mobile"; verified?: boolean }[]

      The WhatsApp phone numbers associated with this company. The maximum amount is 10.

    path?: never
    query?: never
    url: "/companies"

    Settings

    Member Visibility

    On This Page

    Properties