> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Save Contact Entity

> Updates the existing ContactEntity or creates a new ContactEntity if the id parameter is 0.

NsApiSlow threshold: 2000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ContactAgent.json post /api/v1/Agents/Contact/SaveContactEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ContactAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Contact/SaveContactEntity:
    post:
      tags:
        - Contact_Agent
      summary: Save Contact Entity
      description: >-
        Updates the existing ContactEntity or creates a new ContactEntity if the
        id parameter is 0.


        NsApiSlow threshold: 2000 ms.
      operationId: v1ContactAgent_SaveContactEntity
      parameters:
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          text/json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          application/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          text/xml:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
        description: The ContactEntity that is saved
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ContactEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.ContactEntity:
      description: "The Contact Service. The service implements all services working with the Contact object\r\n<para />\r\nCarrier object for ContactEntity.\r\nServices for the ContactEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IContactAgent\">Contact Agent</see>."
      type: object
      properties:
        ContactId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Contact name
          type: string
        Department:
          description: Department
          type: string
        OrgNr:
          description: VAT number or similar
          type: string
        Number1:
          description: Alphanumeric user field
          type: string
        Number2:
          description: Alphanumeric user field
          type: string
        UpdatedDate:
          format: date-time
          description: Date last updated  in UTC.
          type: string
        CreatedDate:
          format: date-time
          description: Date registered  in UTC.
          type: string
        Emails:
          description: The contact's email
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement'
        Interests:
          description: "The contact's available and selected interests. \r\n<para>Use MDO List name \"contint\" to get list items.</para>"
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem
        Urls:
          description: The contact's internet adresses
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement'
        Phones:
          description: The contact's phone numbers
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement'
        Faxes:
          description: The contact's fax numbers
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.EntityElement'
        Description:
          description: Description of the contact. Usually shown as a postit note.
          type: string
        UpdatedBy:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        CreatedBy:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        Associate:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        Business:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Business'
        Category:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Category'
        Country:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Country'
        Persons:
          description: The persons belonging to the contact.
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Person'
        NoMailing:
          description: Spam filter. Indicates if this contact should retrieve advertising.
          type: boolean
        Kananame:
          description: Contact kana name, used in Japanese versions only
          type: string
        Xstop:
          description: STOP flag
          type: boolean
        ActiveInterests:
          format: int32
          description: The number of active interests.
          type: integer
        GroupId:
          format: int32
          description: Group id of original owning associate, semantics like appnt.grp_id
          type: integer
        ActiveStatusMonitorId:
          format: int32
          description: Active status monitor identity with the lowest rank for contact
          type: integer
        SupportAssociate:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate'
        TicketPriority:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketPriority'
        CustomerLanguage:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomerLanguage'
        Deleted:
          format: int32
          description: >-
            If nonzero, then this contact is 'deleted' and should generally not
            be shown
          type: integer
        DbiAgentId:
          format: int32
          description: Integration agent (eJournal)
          type: integer
        DbiLastSyncronized:
          format: date-time
          description: Last external syncronization.
          type: string
        DbiKey:
          description: The primary key for the integrated entry in the external datasource.
          type: string
        DbiLastModified:
          format: date-time
          description: When the entry was last modified.
          type: string
        SupportPerson:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Person'
        Address:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.Address'
        Source:
          format: int32
          description: How did we get this contact? For future integration needs
          type: integer
        ActiveErpLinks:
          format: int32
          description: The number of active erp links
          type: integer
        BounceEmails:
          description: Email addresses with a positive bounce counter.
          type: array
          items:
            type: string
        Domains:
          description: Web domains for this contact, ordered in array by rank
          type: array
          items:
            type: string
        UtmParameters:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.SavedUtmParameters'
        UserDefinedFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.CustomFields} instead.\r\nDictionary of user defined field data.\r\nThe 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\""
          type: object
          additionalProperties:
            type: string
        ExtraFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.ContactEntity.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          type: object
          additionalProperties:
            type: string
        CustomFields:
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.ContactEntity.ExtraFields} and <see cref=\"P:SuperOffice.CRM.Services.ContactEntity.UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.EntityElement:
      description: "Generic carrier object for entity elements such as Phone, EntityElement, Url. These elements do not have id and rank. These values are changed on each save, and should not be depended on. When used in a list or array the rank is the ascending list order.\r\n<para />\r\nCarrier object for EntityElement."
      type: object
      properties:
        Value:
          description: >-
            The Element FullName.  This is a value that is intended to be shown
            to the user.
          type: string
        StrippedValue:
          description: >-
            The Element FullName.  This is a value that can be parsed and used
            by systems.
          type: string
        Description:
          description: The Element Description
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.SelectableMDOListItem:
      description: "Carrier object for SelectableMDOListItem.\r\nServices for the SelectableMDOListItem Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMDOAgent\">MDO Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The Id of the ListItem
          type: integer
        Name:
          description: The name of the ListItem
          type: string
        ToolTip:
          description: The tooltip of the ListItem
          type: string
        Deleted:
          description: The deleted status of the ListItem
          type: boolean
        Rank:
          format: int32
          description: The rank of the ListItem
          type: integer
        Type:
          description: The type of the ListItem. Custom field.
          type: string
        ColorBlock:
          format: int32
          description: The color indicator of the ListItem color block
          type: integer
        IconHint:
          description: The Icon hint of the ListItem. Custom field.
          type: string
        Selected:
          description: True if the ListItem is selected
          type: boolean
        LastChanged:
          format: date-time
          description: Time of last change.
          type: string
        ChildItems:
          description: The child items of the SelectableMDOListItem
          type: array
          items:
            $ref: >-
              #/components/schemas/SuperOffice.CRM.Services.SelectableMDOListItem
        ExtraInfo:
          description: >-
            Extra information added to the ListItem. Could be information such
            as sort order etc or other meta data. Custom field.
          type: string
        StyleHint:
          description: >-
            Style hint indicating, information such as background color etc.
            Custom field.
          type: string
        Hidden:
          description: True if the ListItem is hidden
          type: boolean
        FullName:
          description: The name of the ListItem in its context
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Associate:
      description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAssociateAgent\">Associate Agent</see>."
      type: object
      properties:
        AssociateId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Initials, also login name, possibly database user name
          type: string
        PersonId:
          format: int32
          description: "Owning person record \r\n<para>Use MDO List name \"person\" to get list items.</para>"
          type: integer
        Rank:
          format: int32
          description: Rank order
          type: integer
        Tooltip:
          description: Tooltip or other description
          type: string
        Type:
          description: >-
            User type - 1 = internal user, 2 = resource, 3 = external user, 4 =
            anonymous, 5 = system
          enum:
            - Unknown
            - InternalAssociate
            - ResourceAssociate
            - ExternalAssociate
            - AnonymousAssociate
            - SystemAssociate
          type: string
        GroupIdx:
          format: int32
          description: >-
            Primary group membership, see UserGroupLink for secondary
            memberships
          type: integer
        FullName:
          description: >-
            The associate's culture formatted fullname (firstname, middleName
            and lastname)
          type: string
        FormalName:
          description: >-
            The associate's culture formatted formalname (firstname, middleName
            and lastname, title, mrmrs)
          type: string
        Deleted:
          description: >-
            If true, the user is retired and should have no rights, not appear
            in lists, etc.
          type: boolean
        EjUserId:
          format: int32
          description: >-
            ID of the ej user record corresponding to this associate; 0 for
            associates that are not ej users
          type: integer
        UserName:
          description: User name
          type: string
        ExtraFields:
          description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc."
          type: object
          additionalProperties:
            type: string
        CustomFields:
          description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and <see cref=\"!:UserDefinedFields\">UserDefinedFields</see> properties are deprecated in favor of this\r\ncombined collection."
          type: object
          additionalProperties:
            type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Business:
      description: "Carrier object for Business.\r\nServices for the Business Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Category:
      description: "Carrier object for Category.\r\nServices for the Category Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The category identifier
          type: integer
        Value:
          description: The category name
          type: string
        Tooltip:
          description: The category description
          type: string
        CategoryGroup:
          description: Enum of the group this category belongs to, static list of 5 groups
          enum:
            - Unknown
            - Customer
            - PotentialCustomer
            - Partner
            - Lost
            - Other
          type: string
        EnableLeadStatus:
          description: True if the category should enable lead status
          type: boolean
        Rank:
          format: int32
          description: The rank of the category
          type: integer
        Deleted:
          description: True if the category is deleted
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Country:
      description: "Carrier object for Country.\r\nServices for the Country Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        CountryId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: Name of country in installed language
          type: string
        CurrencyId:
          format: int32
          description: Default currency for this country
          type: integer
        EnglishName:
          description: Name of country in english
          type: string
        TwoLetterISOCountry:
          description: Two-letter country-code according to ISO3166
          type: string
        ThreeLetterISOCountry:
          description: Three-letter country-code according to ISO3166
          type: string
        ImageDescription:
          description: >-
            Description of the country's flag image. (This is the country flag
            that is displayed in the CRM client)
          type: string
        OrgNrText:
          description: Lead text for organisation field
          type: string
        InterAreaPrefix:
          description: International prefix
          type: string
        DialInPrefix:
          description: Dial in prefix
          type: string
        ZipPrefix:
          description: Post prefix
          type: string
        DomainName:
          description: Domain name of the country
          type: string
        AddressLayoutId:
          format: int32
          description: Address layout of the country
          type: integer
        DomesticAddressLayoutId:
          format: int32
          description: Domestic address layout of the country
          type: integer
        ForeignAddressLayoutId:
          format: int32
          description: Foreign address layout of the country
          type: integer
        Rank:
          format: int32
          description: The rank of the country
          type: integer
        Tooltip:
          description: The tooltip of the country
          type: string
        Deleted:
          description: true if the country is deleted
          type: boolean
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Person:
      description: "Carrier object for Person.\r\nServices for the Person Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPersonAgent\">Person Agent</see>."
      type: object
      properties:
        Position:
          description: >-
            The position. This is a predefined SuperOffice value, different from
            Title
          type: string
        PersonId:
          format: int32
          description: Primary key
          type: integer
        Mrmrs:
          description: e.g. Mrs   sex_title
          type: string
        Firstname:
          description: First name
          type: string
        Lastname:
          description: Last name
          type: string
        MiddleName:
          description: Middle name or 'van' etc.
          type: string
        Title:
          description: Title
          type: string
        Description:
          description: Info text/description on person.
          type: string
        Email:
          description: First email on contact person.
          type: string
        FullName:
          description: >-
            Get the persons full name (internal name used in clients for
            employees).
          type: string
        DirectPhone:
          description: Returns the direct phone that belong to the contact person.
          type: string
        FormalName:
          description: >-
            Get formal name for a person, as used in labels. (Full name + person
            title + academic title)
          type: string
        CountryId:
          format: int32
          description: Country
          type: integer
        ContactId:
          format: int32
          description: Owning contact ID
          type: integer
        ContactName:
          description: The persons company name
          type: string
        Retired:
          format: int32
          description: >-
            1 = the user is retired and should have no rights, not appear in
            lists, etc.
          type: integer
        Rank:
          format: int32
          description: Display sort sequence for default sort order
          type: integer
        ActiveInterests:
          format: int32
          description: >-
            Number of records in pintr table; select count(*) from pintr pi
            where pi.person_id = this.person_id == activeInterests is always
            true
          type: integer
        ContactDepartment:
          description: The persons contact department
          type: string
        ContactCountryId:
          format: int32
          description: The persons contact country id
          type: integer
        ContactOrgNr:
          description: The persons contact organization number
          type: string
        FaxPhone:
          description: Returns the fax phone that belong to the contact person.
          type: string
        MobilePhone:
          description: Returns the mobile phone that belong to the contact person.
          type: string
        ContactPhone:
          description: Returns the direct phone that belong to the persons contact.
          type: string
        AssociateName:
          description: Name of the person's owner
          type: string
        AssociateId:
          format: int32
          description: Id of the item's owner (Associate id)
          type: integer
        UsePersonAddress:
          description: If 1, use person's address for mailing instead of company address
          type: boolean
        ContactFax:
          description: Actual phone number as eneterd by the user
          type: string
        Kanafname:
          description: Kana first name, used in Japanese versions only
          type: string
        Kanalname:
          description: Kana last name, used in Japanese versions only
          type: string
        Post1:
          description: Postal address, used in Japanese versions only
          type: string
        Post2:
          description: Postal address, used in Japanese versions only
          type: string
        Post3:
          description: Postal address, used in Japanese versions only
          type: string
        EmailName:
          description: E-mail description
          type: string
        ContactFullName:
          description: Company full name + department
          type: string
        ActiveErpLinks:
          format: int32
          description: How many active ERP links are there for this person?
          type: integer
        TicketPriorityId:
          format: int32
          description: Ticket priority ID
          type: integer
        SupportLanguageId:
          format: int32
          description: Support priority ID
          type: integer
        SupportAssociateId:
          format: int32
          description: Our support contact for this person
          type: integer
        CategoryName:
          description: The category list item name
          type: string
        PersonNumber:
          description: Alphanumeric user field
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketPriority:
      description: "Carrier object for TicketPriority.\r\nServices for the TicketPriority Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.CustomerLanguage:
      description: "Customer languages that customer center supports.\r\n<para />\r\nCarrier object for CustomerLanguage.\r\nServices for the CustomerLanguage Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.Address:
      description: "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.\r\n<para />\r\nCarrier object for Address."
      type: object
      properties:
        Wgs84Latitude:
          format: double
          description: >-
            Latitude (that's north/south), decimal degrees, relative to WGS 84
            ellipsoid. SuperOffice ASA is at 59.91892. This value needs no
            further grid reference or other qualifying information.
          type: number
        Wgs84Longitude:
          format: double
          description: >-
            Longitude (that's East/west), decimal degrees, relative to WGS 84
            ellipsoid. SuperOffice ASA is at 10.73159. This value needs no
            further grid reference or other qualifying information.
          type: number
        LocalizedAddress:
          description: >-
            LocalizedFieldArray is a list of LocalizedFieldList objects. Used to
            store localized information such as formatted address data.
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/SuperOffice.CRM.Services.LocalizedField'
        Street:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress'
        Postal:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.StructuredAddress'
        Formatted:
          description: >-
            Read-only formatted address multi-line string. Combines street and
            postal into one string. e.g.: <c>"Postboks 123,\nBrugata 123,\n1234
            OSLO\n"</c> or <c>"Postbox 123,\nBridgelane 123,\nWest
            Tooting,\nEast Shire ES2 W31\n"</c>.
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.SavedUtmParameters:
      description: "Inital Utm parameters for a given person or contact.\r\n<para />\r\nCarrier object for SavedUtmParameters.\r\nServices for the SavedUtmParameters Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IPersonAgent\">Person Agent</see>."
      type: object
      properties:
        FormName:
          description: The name of form for the first submission
          type: string
        FirsttouchSource:
          description: First touch UTM source
          type: string
        FirsttouchMedium:
          description: First touch UTM medium
          type: string
        FirsttouchCampaign:
          description: First touch UTM campaign
          type: string
        FirsttouchTerm:
          description: First touch UTM term
          type: string
        FirsttouchContent:
          description: First touch UTM content
          type: string
        FirsttouchReferrerDomain:
          description: First touch UTM referrer domain
          type: string
        Source:
          description: UTM source
          type: string
        Medium:
          description: UTM medium
          type: string
        Campaign:
          description: UTM campaign
          type: string
        Term:
          description: UTM term
          type: string
        Content:
          description: UTM content
          type: string
        ReferrerDomain:
          description: UTM referrer domain
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Services.LocalizedField:
      description: "LocalizedField is used to store localized information such as formatted address data, a formatted phone number, etc.\r\n<para />\r\nCarrier object for LocalizedField."
      type: object
      properties:
        Name:
          description: Name of the value field
          type: string
        Value:
          description: The field's value
          type: string
        Tooltip:
          description: The tooltip
          type: string
        Label:
          description: The label of the field
          type: string
        ValueLength:
          format: int32
          description: Database length of the value
          type: integer
        AddressType:
          description: ''
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.StructuredAddress:
      description: "Address with structured fields (Address1, City, Zip) - does not vary its layout by country, unliked the formatted address.\r\n<para />\r\nCarrier object for StructuredAddress."
      type: object
      properties:
        AtypeIdx:
          description: >-
            Bit mask, combines address type (EAddressType) and owner type
            (EOwnerType)
          enum:
            - Unknown
            - ContactPostalAddress
            - ContactStreetAddress
            - PersonPrivateAddress
            - QuoteBillingAddress
            - QuoteShippingAddress
          type: string
        Address1:
          description: Address line 1
          type: string
        Address2:
          description: Address line 2
          type: string
        Address3:
          description: Address line 3
          type: string
        City:
          description: City corresponding to zip code
          type: string
        County:
          description: County (not country)
          type: string
        State:
          description: State
          type: string
        Zipcode:
          description: Zip code, alphanumeric
          type: string
        Formatted:
          description: >-
            Read-only formatted address multi-line string. e.g.: <c>"Brugata
            123,\n1234 OSLO\n"</c> or <c>"Bridgelane 123,\nWest Tooting,\nThe
            Shire ES2 W31\n"</c>.
          type: string
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [Post Contact Entity](/en/api/reference/restful/rest/contact/post-contact-entity.md)
- [NSContactAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSContactAgent.md)
- [How to set an interest on or off for a contact (services)](/en/api/web-services/howto/company/set-interest-on-off-services.md)
- [SuperOffice.WebApi.Agents.ContactAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ContactAgent.md)
- [How to set a user-defined list item on a Udef field (services)](/en/api/web-services/howto/custom-objects/set-udef-listitem-value.md)
- [Save Contact Relation](/en/api/reference/restful/agent/relation_agent/save-contact-relation.md)
