Addresses

REST API: Addresses

Using the REST API, you can create, update and delete addresses within your AMS+ account.

Addresses Resources

• Create
• Update
• Delete

Create

RESOURCE URI

https://app.agencybloc.com/api/v1/addresses/create

REQUIRED POST PARAMETERS

You must POST the following parameters via the body of the request. Parameters found in the querystring of the request will be ignored:

The entityType parameter must be one of the following values:

• Group
• Individual
• Agent
• Carrier

ADDITIONAL POST PARAMETERS

RESPONSE

A return response will be generated after you have consumed the API. Upon successfully creating a new address inside your AMS+ account, you will get a return status of 200 along with the addressID as seen below.

{
    "Agencybloc Response": {
      "Status":"200",
      "addressID":"123456",
      "Action":"delete"
    }
}

Update

RESOURCE URI

https://app.agencybloc.com/api/v1/addresses/update

REQUIRED POST PARAMETERS

You must POST the following parameters via the body of the request. Parameters found in the querystring of the request will be ignored:

ADDITIONAL POST PARAMETERS

RESPONSE

A return response will be generated after you have consumed the API. Upon successfully creating a new address inside your AMS+ account, you will get a return status of 200 along with the addressID as seen below.

{
   "Agencybloc Response": {
      "Status":"200",
      "addressID":"123456",
      "Action":"update"
    }
}    

Delete

RESOURCE URI

https://app.agencybloc.com/api/v1/addresses/delete

REQUIRED POST PARAMETERS

You must POST the following parameter via the body of the request. Parameters found in the querystring of the request will be ignored:

RESPONSE

A return response will be generated after you have consumed the API. Upon successfully creating a new address inside your AMS+ account, you will get a return status of 200 along with the addressID as seen below.

{
  "Agencybloc Response": {
     "Status":"200",
     "addressID":"123456",
     "Action":"delete"
   }
}

Exception Responses

The exception responses will include status, title, and message and be in JSON format.

{
  "Agencybloc Response": {
     "Exception": {
        "Status":"Status Code",
        "Title":"Title of Error",
        "Message":"Error Message"
      }
   }
}