A Contact in the Nue API represents an individual person associated with a Customer account. Contacts are essential for self-service implementations as they serve as the individual users who interact with your platform.

Core Identity FieldsCopied!

id

• Unique identifier for the contact in the Nue system

• Automatically generated upon creation

• Used as a reference in API calls

• Example: "003XX00000fjR1AQAU"

customerId

• Required reference to the Customer account this contact belongs to

• Establishes the parent-child relationship between Customer and Contact

• Example: "001XX00000kpHGvQAM"

name

• The full name of the contact (often auto-generated from first and last name)

• Required field

• Used for display purposes

• Example: "John Smith"

firstName

• The contact's first/given name

• Required field

• Used for personalization in communications

• Example: "John"

lastName

• The contact's surname/family name

• Required field

• Used for formal addressing and sorting

• Example: "Smith"

middleName

• The contact's middle name

• Optional field

• Example: "Robert"

suffix

• Name suffix such as Jr., Sr., III, etc.

• Optional field

• Example: "Jr."

title

• Job title or position of the contact

• Optional field

• Useful for B2B implementations

• Example: "Chief Technology Officer"

Contact Information FieldsCopied!

email

• Email address of the contact

• Required field

• Primary identifier for contact lookup and authentication

• Must be unique within a self-service implementation

• Example: "john.smith@example.com"

phone

• Primary phone number of the contact

• Optional field

• Example: "555-123-4567"

mobilePhone

• Mobile/cell phone number of the contact

• Optional field

• Used for SMS communications

• Example: "555-987-6543"

birthday

• The contact's date of birth

• Optional field

• Format: ISO date string

• Example: "1985-04-15"

Shipping Address FieldsCopied!

shippingStreet

• Street address for shipping

• Optional field

• Example: "123 Main Street, Apt 4B"

shippingCity

• City for shipping address

• Optional field

• Example: "San Francisco"

shippingState

• State/province for shipping address

• Optional field

• Example: "CA"

shippingPostalCode

• Postal/ZIP code for shipping address

• Optional field

• Example: "94105"

shippingCountry

• Country for shipping address

• Optional field

• Example: "United States"

Billing Address FieldsCopied!

billingStreet

• Street address for billing

• Optional field

• Example: "123 Main Street, Apt 4B"

billingCity

• City for billing address

• Optional field

• Example: "San Francisco"

billingState

• State/province for billing address

• Optional field

• Example: "CA"

billingPostalCode

• Postal/ZIP code for billing address

• Optional field

• Example: "94105"

billingCountry

• Country for billing address

• Optional field

• Example: "United States"

System FieldsCopied!

createdById

• ID of the user who created this contact record

• Automatically populated

• Example: "005XX00000BpP6iQAF"

createdDate

• Date and time when the contact record was created

• Automatically populated

• Format: ISO datetime

• Example: "2023-03-15T14:30:45.000Z"

lastModifiedById

• ID of the user who last modified this contact record

• Automatically populated

• Example: "005XX00000CeR8jQAF"

lastModifiedDate

• Date and time when the contact record was last modified

• Automatically populated

• Format: ISO datetime

• Example: "2023-04-22T09:12:18.000Z"