Contact

Return, update and create a customer contacts.

Date Released: May 30th 2014 Date Updated:November 14th 2014
URLSupports

{URI}/contact/

{URI}/contact/search?q={query}

GET |  PUT |  POST

GET |  PUT |  POST

{URI} is exo.api.myob.com when connecting to the cloud or the address of the machine hosting the API when connecting on premise.

search returns contacts that match the specified search string.

The elements list below details information for Contact. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Attribute Details

    • jobtitle string,null
    • Type: string,null
    • firstname string,null
    • Type: string,null
    • lastname string,null
    • Type: string,null
    • fullname string,null
    • Type: string,null
    • directphonenumber string,null
    • Type: string,null
    • mobilephonenumber string,null
    • Type: string,null
    • email string,null
    • Type: string,null
    • postaladdress object
    • Type: object
      • line1 string,null
      • Type: string,null
      • line2 string,null
      • Type: string,null
      • line3 string,null
      • Type: string,null
      • line4 string,null
      • Type: string,null
      • line5 string,null
      • Type: string,null
    • postalcode string,null
    • Type: string,null
    • deliveryaddress object
    • Type: object
      • line1 string,null
      • Type: string,null
      • line2 string,null
      • Type: string,null
      • line3 string,null
      • Type: string,null
      • line4 string,null
      • Type: string,null
      • line5 string,null
      • Type: string,null
      • line6 string,null
      • Type: string,null
    • advertsourceid integer,null
    • Required on PUT
    • advertsource object,null
    • Type: object,null
      • description string,null
      • Type: string,null
      • processid integer
      • Required on PUT
      • communicationprocess object,null
      • Type: object,null
        • description string,null
        • Type: string,null
        • rel string,null
        • Type: string,null
        • title string,null
        • Type: string,null
        • id integer
        • Required on PUT
        • href string,null
        • Type: string,null
      • rel string,null
      • Type: string,null
      • title string,null
      • Type: string,null
      • id integer
      • Required on PUT
      • href string,null
      • Type: string,null
    • active boolean,null
    • Type: boolean,null
    • optoutemarketing boolean,null
    • Type: boolean,null
    • salespersonid integer,null
    • Required on PUT
    • salesperson object,null
    • Type: object,null
      • name string,null
      • Type: string,null
      • jobtitle string,null
      • Type: string,null
      • rel string,null
      • Type: string,null
      • title string,null
      • Type: string,null
      • id integer
      • Required on PUT
      • href string,null
      • Type: string,null
    • defaultcompany object,null
    • EXO Business Company
      Title: BaseCompany
      • companytype integer
      • Type: integer
      • accountname string
      • Type: string
      • email string,null
      • Type: string,null
      • phone string,null
      • Type: string,null
      • postaladdress object
      • Type: object
        • line1 string,null
        • Type: string,null
        • line2 string,null
        • Type: string,null
        • line3 string,null
        • Type: string,null
        • line4 string,null
        • Type: string,null
        • line5 string,null
        • Type: string,null
      • postalcode string,null
      • Type: string,null
      • deliveryaddress object
      • Type: object
        • line1 string,null
        • Type: string,null
        • line2 string,null
        • Type: string,null
        • line3 string,null
        • Type: string,null
        • line4 string,null
        • Type: string,null
        • line5 string,null
        • Type: string,null
        • line6 string,null
        • Type: string,null
      • defaultcontactid integer,null
      • Required on PUT
      • defaultcontact undefined
      • Type: undefined
      • contacts object,null
      • Type: object,null
        • rel string,null
        • Type: string,null
        • title string,null
        • Type: string,null
        • href string,null
        • Type: string,null
      • website string,null
      • Type: string,null
      • salespersonid integer,null
      • Required on PUT
      • salesperson object,null
      • Type: object,null
        • name string,null
        • Type: string,null
        • jobtitle string,null
        • Type: string,null
        • rel string,null
        • Type: string,null
        • title string,null
        • Type: string,null
        • id integer
        • Required on PUT
        • href string,null
        • Type: string,null
      • balance number
      • Type: number
      • contactname string,null
      • Type: string,null
      • latitude number,null
      • Type: number,null
      • longitude number,null
      • Type: number,null
      • geocodestatus integer,null
      • Type: integer,null
      • extrafields array,null
      • Type: array,null
      • rel string,null
      • Type: string,null
      • title string,null
      • Type: string,null
      • id integer
      • Required on PUT
      • href string,null
      • Type: string,null
    • defaultcompanyid object,null
    • EXO Business Company Link
      Title: CompanyId
      Required on PUT
      • companytype integer
      • Type: integer
      • accno integer
      • Type: integer
    • defaultcompanyname string,null
    • Type: string,null
    • latitude number,null
    • Type: number,null
    • longitude number,null
    • Type: number,null
    • geocodestatus integer,null
    • Type: integer,null
    • extrafields array,null
    • Type: array,null
    • rel string,null
    • Type: string,null
    • title string,null
    • Type: string,null
    • id integer
    • Required on PUT
    • href string,null
    • Type: string,null

Example json GET response

  • {
    • jobtitle : Sales
    • firstname : Rob
    • lastname : Myers
    • fullname : Rob Myers
    • directphonenumber : +64 9-324 6215
    • mobilephonenumber : +64 29-636 304
    • postaladdress
      • {
        • line1 : Po Box 3794
        • line2 : Auckland
        • line3 :
        • line4 : New Zealand
        • line5
      • }
    • postalcode :
    • deliveryaddress
      • {
        • line1 : 59 Princes St
        • line2 : Auckland
        • line3 :
        • line4 : New Zealand
        • line5
        • line6
      • }
    • advertsourceid : 0
    • active : true
    • optoutemarketing : false
    • salespersonid : 4
    • defaultcompanyid
    • defaultcompanyname
    • geocodestatus : -1
    • extrafields
      • {
        • 0
          • {
            • key : X_DATEOFBIRTH
            • value
          • }
        • 1
          • {
            • key : X_NOMARKETING
            • value
          • }
        • 2
          • {
            • key : X_SOURCE
            • value
          • }
      • }
    • id : 5
    • href : {URI}https://exo-stage.api.myob.com/contact/5
  • }

{URI} is defined as: http://exo.api.myob.com/