Skip to main content

UpdateContactDetailsInput

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

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

Fields

`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.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.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.socialMedia` ● `ContactSocialMediaInput` input

The social media details for 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.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

Fields
Member Of