POST Contacts/Contact?validateOnly={validateOnly}

Add contact

Request Information

URI Parameters

NameDescriptionTypeAdditional information
validateOnly

Validate data, but don't post it

boolean

Default value is False

Body Parameters

Contact data

ContactDTO
NameDescriptionTypeAdditional information
ContactID

A direct mapping to EntityID

integer

None.

ContactType

The Contact Type of the Contact, be it Gobal, Personal, or Business .

ContactType

None.

ContactTypeEntryID

The unique identifier of the Contact's Contact Type. Input from code table entries where TableName is "Contact Types", ().

integer

None.

ContactTypeEntryValue

The Name of the Contact's Contact Type. Input from code table entries where TableName is "Contact Types", ().

string

None.

Area

The Contact's Area. Input from code table entries where TableName is "Area", ().

string

None.

Name

The Contact's Name including prefix and suffix, .

NameDTO

None.

Addresses

A List of the Contact's Addresses .

AddressesDTO

None.

BusinessUnits

A list of links between this Contact and Business units .

Collection of ContactBusinessUnitDTO

None.

CommunicationMethods

A list of Communication method information for this Contact .

CommunicationMethodsDTO

None.

OrganizationName

The name of the Organization this Contact is associated with.

string

None.

JobTitle

The Job Title for the Contact. Input from code table entries where TableName is "Job Titles", ().

string

None.

MaritalStatus

The Marital Status of the Contact. Input from code table entries where TableName is "Marital Statuses", ().

string

None.

Gender

The Contact's Gender. Input from code table entries where TableName is "Genders", ().

string

None.

BirthDate

The Contact's Birth Date .

date

None.

IsBirthDateEstimated

Is the Birth Date specified for the Contact estimated.

boolean

None.

BirthMonth

The numerical Birth Month of the Contact.

byte

None.

BirthDay

The numerical Birth Day of the Contact.

byte

None.

BirthCountryCode

Birth Country Code.

string

None.

TZIDEntryID

The Timezone of the Contact. Input from code table entries where TableName is "Timezones (TZID)", ().

integer

None.

WindowsTZEntryID

The Windows Timezone for the Contact.

integer

None.

Props

Additional properties for the Contact record. .

Collection of Object

None.

Comments

Comments associated with the Contact.

string

None.

RecordState

The Record state of the Contact.

RecordState

None.

Created

The audit information for the creation of the record, including the creation date in UTC and the user who created it, . This field is readonly.

AuditDataDTO

None.

LastUpdated

The audit information for the last update to the record, including the update date in UTC and the user who made the update, . This field is readonly.

AuditDataDTO

None.

Notifications

A (potential) list of Notifications attached to the Contact .

Collection of ContactNotificationDTO

None.

Extensions

A (potential) list of additional data from extension forms attached to the Contact .

Collection of FormDataExtensionDto

None.

PartialData

PartialDataType

None.

Summary

The Summary of the Contact's Name field, . This field is readonly.

string

None.

ImageExists

Is there an image for the Contact.

boolean

None.

ImageEntityFileID

A Link to the Image Entity File ID using it's unique identifier.

integer

None.

ImageEntityFileKey

A key used to identify the EntityImageFile when using the Contacts/File/ViaKey/{key?}/{resultAtBased64:bool?} endpoint.

string

None.

ImageEntityFileDateUtc

The audit information for the ImageEntityFile, namely the creation date in UTC .

date

None.

ImageEntityFileLastUpdatedDateUtc

The audit information for the ImageEntityFile, namely the timestamp of the last update in UTC .

date

None.

Global

Is the Contact Global.

boolean

None.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.