Carriers

REST API: Carriers

Using the Carriers REST API, you can create, search, and update carriers within your AMS+ account.

Carrier Resources

• Create
• Search
• Update

Create

RESOURCE URI

https://app.agencybloc.com/api/v1/carriers/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:

ADDITIONAL POST PARAMETERS

You may also POST any of the following parameters:

You may also POST phone numbers for the new carrier using these parameters:

When sending phone numbers via POST, please ensure that all phone numbers are formatted as (319) 555-0000.

You may also POST address information for the new carrier using these parameters:

Note: You can also create, update and delete addresses using the Addresses API.

Custom Fields

The REST API allows access to the custom fields inside your account when creating a new carrier. In order to pass custom fields via the REST API, you will need to preface the names of the custom fields inside your account with 'custom_'. To obtain the name values for the custom fields, you will need to access the custom fields page below.

https://app.agencybloc.com/settings/custom-fields/Carrier/list

By selecting the entity type from the dropdown, you will see the list of that entity's custom fields. All names must match exactly what is listed on the page, along with the preface of 'custom_'.

Note: When passing custom field data for Checkbox List custom fields, multiple values need to be separated by ||. For example, “option 1||option 2”.

RESPONSE

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

{ 
  "Agencybloc Response": { 
     "Status":"200", 
     "carrierID":"123456", 
     "Action":"create" 
  } 
}

Search

RESOURCE URI

https://app.agencybloc.com/api/v1/carriers/search

REQUIRED POST PARAMETERS

There are no required POST parameters for searching. However, if you do not include any parameters the results are limited to 50 carriers.

ADDITIONAL POST PARAMETERS

You may also POST any of the following parameters:

RESPONSE

[
  {
     "carrierID": 123456,
     "carrierName": "Carrier Example",
     "carrierAbbreviation": "CE",
     "homePhone": "(555) 555-5555",
     "businessPhone": "(444) 444-4444",
     "cellPhone": "(333) 333-3333"
  }
]

Update

RESOURCE URI

https://app.agencybloc.com/api/v1/carriers/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

You may also POST any of the following parameters:

You may also POST phone numbers for the new carrier using these parameters:

When sending phone numbers via POST, please ensure that all phone numbers are formatted as (319) 555-0000.

Note: You may also update addresses for the carrier using the Addresses API.

Custom Fields

The REST API allows access to the custom fields inside your account when updating a carrier. In order to pass custom fields via the REST API, you will need to preface the names of the custom fields inside your account with 'custom_'. To obtain the name values for the custom fields, you will need to access the custom fields page below.

https://app.agencybloc.com/settings/custom-fields/Carrier/list

By selecting the entity type from the dropdown, you will see the list of that entity's custom fields. All names must match exactly what is listed on the page, along with the preface of 'custom_'.

Note: When passing custom field data for Checkbox List custom fields, multiple values need to be separated by ||. For example, “option 1||option 2”.

RESPONSE

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

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

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"
  }
}