Skip to main content

CreateContactInput

A contact method of a partner, such as an email address or phone number.

input CreateContactInput {
contactName: String
contactTitle: String
department: String
firstName: String
id: ID
isActive: Boolean!
isDefault: Boolean!
label: String
lastName: String
notes: String
preferredTime: String
priority: ContactPriority!
referenceId: String
role: PartnerRole
timeZone: String
type: ContactType!
value: String!
}

Fields​

CreateContactInput.contactName ● String scalar​

Full display name, kept as First Last. Every existing reader (global search, PDFs, address labels) still reads this; the split halves below are what a customer login is matched on.

CreateContactInput.contactTitle ● String scalar​

The person's job title.

CreateContactInput.department ● String scalar​

The person's department.

CreateContactInput.firstName ● String scalar​

Given name. Together with lastName this derives the contact's reference id and matches the person to their customer login — which is why it is stored rather than split off contactName at the first space.

CreateContactInput.id ● ID scalar​

The ID of an existing contact to update in place, so its ID and reference are kept. Leave out for a new contact.

CreateContactInput.isActive ● Boolean! non-null scalar​

Whether the record is active.

CreateContactInput.isDefault ● Boolean! non-null scalar​

Whether this is the default.

CreateContactInput.label ● String scalar​

A label for the contact.

CreateContactInput.lastName ● String scalar​

Family name. See firstName.

CreateContactInput.notes ● String scalar​

Notes about the contact.

CreateContactInput.preferredTime ● String scalar​

The best time to reach them.

CreateContactInput.priority ● ContactPriority! non-null enum​

Whether this is the primary or a secondary contact.

CreateContactInput.referenceId ● String scalar​

The permanent reference of the contact person. Send it back unchanged so a save does not make a new one.

CreateContactInput.role ● PartnerRole enum​

Whether the contact is for a customer or a vendor role.

CreateContactInput.timeZone ● String scalar​

Their time zone.

CreateContactInput.type ● ContactType! non-null enum​

The kind of contact, for example email or phone.

CreateContactInput.value ● String! non-null scalar​

The email address or phone number.

Member Of​

CreatePartnerInput input ● UpdatePartnerInput input