Skip to main content

CreateContactStoreContactInput

Defines the input details for creating a contact in a contact store. At least one of lastName, organizationName, or primaryEmail must be provided.

input CreateContactStoreContactInput {
  billing: CreateContactBillingInput
  biography: String
  contactPhoneNumbers: ContactPhoneNumbersInput
  contactStoreId: ID!
  customFields: [CustomFieldInput!]
  department: String
  externalIdentifier: String
  firstName: String
  inactiveSince: DateTime
  jobTitle: String
  lastName: String
  marketingPrivacy: ContactMarketingPrivacyStatus
  middleName: String
  organizationName: String
  preferredName: ContactPreferredNameInput
  primaryAddress: AddressInput
  primaryEmail: EmailAddress
  secondaryAddress: AddressInput
  socialMedia: ContactSocialMediaInput
  suffix: String
  title: String
  useSecondaryAddress: Boolean
  userDefinedField1: String
  userDefinedField2: String
  userDefinedField3: String
  userDefinedField4: String
  website: String
}

Fields​

CreateContactStoreContactInput.billing ● CreateContactBillingInput input​

The billing details of the contact. Optional.

CreateContactStoreContactInput.biography ● String scalar​

UTF-8 string value that represents the biography of the contact. Optional.

CreateContactStoreContactInput.contactPhoneNumbers ● ContactPhoneNumbersInput input​

A list of phone numbers of the contact. Optional.

CreateContactStoreContactInput.contactStoreId ● ID! non-null scalar​

The identifier of the contact store the contact is to be added to.

CreateContactStoreContactInput.customFields ● [CustomFieldInput!] list input​

The custom fields to create for the contact. Optional.

CreateContactStoreContactInput.department ● String scalar​

UTF-8 string value that represents the department of the contact. Optional.

CreateContactStoreContactInput.externalIdentifier ● String scalar​

UTF-8 string value that represents the external identifier of the contact. Optional.

CreateContactStoreContactInput.firstName ● String scalar​

UTF-8 string value that represents the first name of the contact. Optional.

CreateContactStoreContactInput.inactiveSince ● DateTime scalar​

The date and time since the contact has been inactive. Optional.

If omitted or set to null, the contact will be created as active.

CreateContactStoreContactInput.jobTitle ● String scalar​

UTF-8 string value that represents the job title of the contact. Optional.

CreateContactStoreContactInput.lastName ● String scalar​

UTF-8 string value that represents the last name of the contact. Optional, unless neither primaryEmail or organizationName are specified.

CreateContactStoreContactInput.marketingPrivacy ● ContactMarketingPrivacyStatus enum​

Represents the preference of the contact with regard to marketing material. Optional.

CreateContactStoreContactInput.middleName ● String scalar​

UTF-8 string value that represents the middle name of the contact. Optional.

CreateContactStoreContactInput.organizationName ● String scalar​

UTF-8 string value that represents the organization name of the contact. Optional, unless neither lastName or primaryEmail are specified.

CreateContactStoreContactInput.preferredName ● ContactPreferredNameInput input​

The contact's preferred name details. Optional.

CreateContactStoreContactInput.primaryAddress ● AddressInput input​

The primary address for the contact. Optional.

CreateContactStoreContactInput.primaryEmail ● EmailAddress scalar​

The contact's primary email address. Optional, unless neither lastName or organizationName are specified.

CreateContactStoreContactInput.secondaryAddress ● AddressInput input​

The secondary address for the contact. Optional.

CreateContactStoreContactInput.socialMedia ● ContactSocialMediaInput input​

The social media details for the contact. Optional.

CreateContactStoreContactInput.suffix ● String scalar​

UTF-8 string value that represents the name suffix for this contact. Optional.

CreateContactStoreContactInput.title ● String scalar​

UTF-8 string value that represents the title of the contact's name such as Dr/Mrs/Mr. Optional.

CreateContactStoreContactInput.useSecondaryAddress ● Boolean scalar​

A flag indicating that the contact’s secondary address should be used instead of the primary address. Optional.

The default value is false.

CreateContactStoreContactInput.userDefinedField1 ● String scalar​

UTF-8 string value that represents the user defined field 1 of the contact. Optional.

CreateContactStoreContactInput.userDefinedField2 ● String scalar​

UTF-8 string value that represents the user defined field 2 of the contact. Optional.

CreateContactStoreContactInput.userDefinedField3 ● String scalar​

UTF-8 string value that represents the user defined field 3 of the contact. Optional.

CreateContactStoreContactInput.userDefinedField4 ● String scalar​

UTF-8 string value that represents the user defined field 4 of the contact. Optional.

CreateContactStoreContactInput.website ● String scalar​

UTF-8 string value that represents the website of the contact. Optional.

Member Of​

createContactStoreContact mutation