Home | Index

Address Book XML/JSON API Developer Guide

Example using JSON

The following Request finds a contact:

http://api.address.yahoo.com/api/ws/v1/searchContacts
   ?format=json
   &fields=name,nickname
   &nickname.is=marge
http://address.yahooapis.com/v1/searchContacts
   ?format=json
   &fields=name,nickname
   &nickname.is=marge

The Request returns the following Response:

{ "type": "search_response",
  contacts: [
    { "type": "contact",
      "cid": 34,
      "fields": [
        { "type": "name",
          "fid": 38,
          "first": "Marjorie",
          "last": "Bouvier"
        },
        { "type": "nickname"
          "fid": 37,
          "data": "Marge"
        }
      ]
    }
  ]
}

The following Request and POST body updates a surname:

http://address.yahooapis.com/v1/synchronize
   ?format=json
   &myrev=0
   &nodiffs=1
{ "type": "sync_request"
  "contacts": [
    { "type": "update_contact",
      "cid": 34,
      "fields": [
        { "type": "update_name",
          "fid": 38
          "first": "Marjorie",
          "last": "Simpson"
        }
      ]
    }
  ]
}

The Request returns the following Response:

{ "type": "sync_response",
  "results": [
    { "type": "success" }
  ]
}