Agent Licenses

REST API: Agent Licenses

Using the Agent License REST API, you can manage agent licenses within your AMS+ account.

When creating or updating field values that use a checkbox list or dropdown with user-defined values in Data & Custom Fields via API request, please note that any new values that did not previously exist will be automatically added.

Agent License Resources

• Create
• Update
• Download

Create

RESOURCE URI

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

When sending dates via POST, please ensure that the dates are formatted as 01/01/2013.

Custom Fields

The REST API allows access to the custom fields inside your account when creating a new agent license. 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/agent-license/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 agent license inside your AMS+ account, you will get a return status of 200 along with the agentLicenseID as seen below.

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

Update

RESOURCE URI

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

When sending dates via POST, please ensure that the dates are formatted as 01/01/2013.

Custom Fields

The REST API allows access to the custom fields inside your account when updating an agent license. 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/agent-license/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 an agent inside your AMS+ account, you will get a return status of 200 along with the groupID as seen below.

{ 
  "Agencybloc Response": { 
     "Status":"200", 
     "agentID":"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"
     }
  }
}