Skip to main content
Create Default Contact Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response

OK

The Contact Service. The service implements all services working with the Contact object Carrier object for ContactEntity. Services for the ContactEntity Carrier is available from the Contact Agent.

ContactId
integer<int32>

Primary key

Name
string

Contact name

Department
string

Department

OrgNr
string

VAT number or similar

Number1
string

Alphanumeric user field

Number2
string

Alphanumeric user field

UpdatedDate
string<date-time>

Date last updated in UTC.

CreatedDate
string<date-time>

Date registered in UTC.

Emails
object[]

The contact's email

Interests
object[]

The contact's available and selected interests. Use MDO List name "contint" to get list items.

Urls
object[]

The contact's internet adresses

Phones
object[]

The contact's phone numbers

Faxes
object[]

The contact's fax numbers

Description
string

Description of the contact. Usually shown as a postit note.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Business
object

Carrier object for Business. Services for the Business Carrier is available from the List Agent.

Category
object

Carrier object for Category. Services for the Category Carrier is available from the List Agent.

Country
object

Carrier object for Country. Services for the Country Carrier is available from the List Agent.

Persons
object[]

The persons belonging to the contact.

NoMailing
boolean

Spam filter. Indicates if this contact should retrieve advertising.

Kananame
string

Contact kana name, used in Japanese versions only

Xstop
boolean

STOP flag

ActiveInterests
integer<int32>

The number of active interests.

GroupId
integer<int32>

Group id of original owning associate, semantics like appnt.grp_id

ActiveStatusMonitorId
integer<int32>

Active status monitor identity with the lowest rank for contact

SupportAssociate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

TicketPriority
object

Carrier object for TicketPriority. Services for the TicketPriority Carrier is available from the List Agent.

CustomerLanguage
object

Customer languages that customer center supports. Carrier object for CustomerLanguage. Services for the CustomerLanguage Carrier is available from the List Agent.

Deleted
integer<int32>

If nonzero, then this contact is 'deleted' and should generally not be shown

DbiAgentId
integer<int32>

Integration agent (eJournal)

DbiLastSyncronized
string<date-time>

Last external syncronization.

DbiKey
string

The primary key for the integrated entry in the external datasource.

DbiLastModified
string<date-time>

When the entry was last modified.

SupportPerson
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

Address
object

Street and/or Postal address, in both formatted and structured forms. You only need to modify one of the two for the change to be registered. Carrier object for Address.

Source
integer<int32>

How did we get this contact? For future integration needs

The number of active erp links

BounceEmails
string[]

Email addresses with a positive bounce counter.

Domains
string[]

Web domains for this contact, ordered in array by rank

UtmParameters
object

Inital Utm parameters for a given person or contact. Carrier object for SavedUtmParameters. Services for the SavedUtmParameters Carrier is available from the Person Agent.

UserDefinedFields
object

Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

ExtraFields
object

Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

CustomFields
object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.ContactEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.