Skip to main content

UpdateContactDetailsInput

Defines the input for updating the contact details for a contact in an event.

input UpdateContactDetailsInput {
  additionalEmails: [EmailAddress!]
  address: AddressInput @deprecated
  biography: String
  contactId: ID!
  contactPhoneNumbers: ContactPhoneNumbersInput
  customFields: [CustomFieldInput!]
  department: String
  dietary: ContactDietaryInput
  eventId: ID!
  externalIdentifier: String
  firstName: String
  inactiveSince: DateTime
  jobTitle: String
  lastName: String
  marketingPrivacy: ContactMarketingPrivacyStatus
  middleName: String
  organizationName: String
  photo: ContactPhotoInput
  preferredNameDetails: ContactPreferredNameInput
  primaryAddress: AddressInput
  primaryEmail: EmailAddress
  secondaryAddress: AddressInput
  socialMedia: ContactSocialMediaInput
  subDepartment: String
  suffix: String
  taxNumber: String
  title: String
  useSecondaryAddress: Boolean
  userDefinedField1: String
  userDefinedField2: String
  userDefinedField3: String
  userDefinedField4: String
  website: String
}

Fields​

UpdateContactDetailsInput.additionalEmails ● [EmailAddress!] list scalar​

The contact's additional email addresses. Optional.

Passing null or an empty list will remove all additional emails from the contact. If passing a list, omitted existing additional emails will be removed from this contact. Omitting the input value entirely will keep the existing additional emails as-is.

UpdateContactDetailsInput.address ● AddressInput deprecated input​

DEPRECATED

Use primaryAddress instead. This input field will be removed in a future release.

The details to update the address to. Optional.

This field has been deprecated and will be removed in a future release, please use primaryAddress instead. If both address and primaryAddress are specified, then address will be ignored.

UpdateContactDetailsInput.biography ● String scalar​

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

UpdateContactDetailsInput.contactId ● ID! non-null scalar​

The identifier of the contact.

UpdateContactDetailsInput.contactPhoneNumbers ● ContactPhoneNumbersInput input​

A list of phone numbers of the contact. Optional.

UpdateContactDetailsInput.customFields ● [CustomFieldInput!] list input​

The custom fields to update or create for the contact. Optional.

UpdateContactDetailsInput.department ● String scalar​

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

UpdateContactDetailsInput.dietary ● ContactDietaryInput input​

The dietary information for the contact. Optional.

Rules:

  • Omitting the input value entirely will keep the existing dietary information as-is.
  • Passing null for the input will remove all requirements and the other dietary requirement from this contact.
  • Omitting requirementIds will keep the existing requirements as-is.
  • Passing null or an empty list for requirementIds will remove all requirements from this contact.
  • If passing a list for requirementIds, omitted existing requirements will be removed from this contact.
  • Omitting other will keep the existing other dietary requirement as-is.

UpdateContactDetailsInput.eventId ● ID! non-null scalar​

The identifier of the event the contact is associated with.

UpdateContactDetailsInput.externalIdentifier ● String scalar​

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

UpdateContactDetailsInput.firstName ● String scalar​

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

UpdateContactDetailsInput.inactiveSince ● DateTime scalar​

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

Rules:

  • If omitted, the inactive status of the contact will not be changed.
  • When a value is specified, the inactive date of the status will be updated.
  • When set to null, the contact will be updated to be active.

UpdateContactDetailsInput.jobTitle ● String scalar​

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

UpdateContactDetailsInput.lastName ● String scalar​

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

UpdateContactDetailsInput.marketingPrivacy ● ContactMarketingPrivacyStatus enum​

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

UpdateContactDetailsInput.middleName ● String scalar​

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

UpdateContactDetailsInput.organizationName ● String scalar​

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

UpdateContactDetailsInput.photo ● ContactPhotoInput input​

The contact's photo. Optional.

Passing null will remove the photo. Omitting the input value entirely will keep the photo as-is.

UpdateContactDetailsInput.preferredNameDetails ● ContactPreferredNameInput input​

The contact's preferred name details. Optional.

UpdateContactDetailsInput.primaryAddress ● AddressInput input​

The details to update the address to. Optional.

UpdateContactDetailsInput.primaryEmail ● EmailAddress scalar​

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

UpdateContactDetailsInput.secondaryAddress ● AddressInput input​

The secondary address for the contact. Optional.

UpdateContactDetailsInput.socialMedia ● ContactSocialMediaInput input​

The social media details for the contact. Optional.

UpdateContactDetailsInput.subDepartment ● String scalar​

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

UpdateContactDetailsInput.suffix ● String scalar​

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

UpdateContactDetailsInput.taxNumber ● String scalar​

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

UpdateContactDetailsInput.title ● String scalar​

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

UpdateContactDetailsInput.useSecondaryAddress ● Boolean scalar​

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

UpdateContactDetailsInput.userDefinedField1 ● String scalar​

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

UpdateContactDetailsInput.userDefinedField2 ● String scalar​

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

UpdateContactDetailsInput.userDefinedField3 ● String scalar​

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

UpdateContactDetailsInput.userDefinedField4 ● String scalar​

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

UpdateContactDetailsInput.website ● String scalar​

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

Member Of​

updateContactDetails mutation