Read and update AgencyBloc individuals, groups, policies and agents; log activities and notes.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: log an activity (call, task, renewal reminder) on a group, individual, agent, carrier or lead. Status, type, method and priority are the text values of the account's dropdowns (My Agency Settings > Data Administration); unknown values are created. When the status is not Complete the activity is a follow-up: give follow_up_user_id and follow_up_date (and start/end times), and AgencyBloc assigns it to that user. Nothing is sent to the customer. Activities cannot be edited or deleted through the API. Returns the new activityID. POST activities/create.
Activity type, e.g. Renewal.
The activity text.
Activity method, e.g. Phone or Email.
e.g. Complete or In Progress.
e.g. Low, Medium or High.
Id of the record.
Defaults to today.
A date, yyyy-mm-dd.
AgencyBloc user the follow-up is assigned to.
A policy of this group or individual.
24-hour HH:MM or HH:MM:SS.
24-hour HH:MM or HH:MM:SS.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: log an activity (call, task, renewal reminder) on a group, individual, agent, carrier or lead. Status, type, method and priority are the text values of the account's dropdowns (My Agency Settings > Data Administration); unknown values are created. When the status is not Complete the activity is a follow-up: give follow_up_user_id and follow_up_date (and start/end times), and AgencyBloc assigns it to that user. Nothing is sent to the customer. Activities cannot be edited or deleted through the API. Returns the new activityID. POST activities/create.
| Argument | Type | Description |
|---|---|---|
| type* | string | Activity type, e.g. Renewal. |
| notes* | string | The activity text. |
| method* | string | Activity method, e.g. Phone or Email. |
| status* | string | e.g. Complete or In Progress. |
| subject* | string | |
| priority* | string | e.g. Low, Medium or High. |
| entity_id* | integer | Id of the record. |
| entity_type* | string | |
| activity_date | string | Defaults to today. |
| follow_up_date | string | A date, yyyy-mm-dd. |
| follow_up_all_day | boolean | |
| follow_up_user_id | integer | AgencyBloc user the follow-up is assigned to. |
| related_policy_id | integer | A policy of this group or individual. |
| follow_up_end_time | string | 24-hour HH:MM or HH:MM:SS. |
| follow_up_start_time | string | 24-hour HH:MM or HH:MM:SS. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_id",
"entity_type",
"subject",
"notes",
"status",
"type",
"method",
"priority"
],
"properties": {
"type": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Activity type, e.g. Renewal."
},
"notes": {
"type": "string",
"maxLength": 8000,
"minLength": 1,
"description": "The activity text."
},
"method": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Activity method, e.g. Phone or Email."
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "e.g. Complete or In Progress."
},
"subject": {
"type": "string",
"maxLength": 250,
"minLength": 1
},
"priority": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "e.g. Low, Medium or High."
},
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record.",
"exclusiveMinimum": 0
},
"entity_type": {
"enum": [
"Group",
"Individual",
"Agent",
"Carrier",
"Lead"
],
"type": "string"
},
"activity_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Defaults to today."
},
"follow_up_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"follow_up_all_day": {
"type": "boolean"
},
"follow_up_user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "AgencyBloc user the follow-up is assigned to.",
"exclusiveMinimum": 0
},
"related_policy_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "A policy of this group or individual.",
"exclusiveMinimum": 0
},
"follow_up_end_time": {
"type": "string",
"description": "24-hour HH:MM or HH:MM:SS."
},
"follow_up_start_time": {
"type": "string",
"description": "24-hour HH:MM or HH:MM:SS."
}
}
}WRITE: create a new group (employer / business account) in AgencyBloc. It does not check for duplicates: search first. Returns the new groupID. POST groups/create.
| Argument | Type | Description |
|---|---|---|
| dba | string | Doing-business-as name. |
| zip | string | |
| city | string | |
| type | string | Group type as configured in the account. |
| state | string | Two-letter state abbreviation. |
| status | string | |
| street1 | string | |
| street2 | string | |
| website | string | |
| industry | string | |
| employees | integer | Number of employees. |
| group_name |
WRITE: create a new individual (client or contact) in AgencyBloc. Needs first and last name; everything else is optional. It does not check for duplicates: search first. Returns the new individualID. POST individuals/create.
| Argument | Type | Description |
|---|---|---|
| zip | string | |
| city | string | |
| tags | string | Tags (replaces existing tags on update; an empty string clears them). |
| type | string | Type as configured in the account; an unknown value is created. |
| string | ||
| state | string | Two-letter state abbreviation. |
| gender | string | |
| status | string | Status as configured in the account; an unknown value is created. |
| street1 | string | |
| street2 | string | |
| group_id |
WRITE: add one note (subject + body) to an agent, group, individual or policy. AgencyBloc never allows notes to be edited or deleted through the API (audit rule), so the note is permanent. Pinning a note unpins the previously pinned one. Returns the new note id. POST notes/create.
| Argument | Type | Description |
|---|---|---|
| body* | string | |
| pinned | boolean | Pin the note (unpins any other pinned note). Default false. |
| subject* | string | |
| entity_id* | integer | Id of the record. |
| entity_type* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_id",
"entity_type",
"subject",
"body"
],
"properties": {
"body": {
"type": "string",
"maxLength": 8000,
"minLength": 1
},
"pinned": {
"type": "boolean",
"description": "Pin the note (unpins any other pinned note). Default false."
},
"subject": {
"type": "string",
"maxLength": 250,
"minLength": 1
},
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record.",
"exclusiveMinimum": 0
},
"entity_type": {
"enum": [
"Agent",
"Group",
"Individual",
"Policy"
],
"type": "string"
}
}
}WRITE: create a policy on an existing group or individual. Needs the holder (entity_id + entity_type), coverage type, status and the carrier's full name; unknown coverage types / statuses are created in the account. Returns the new policyID. POST policies/create.
| Argument | Type | Description |
|---|---|---|
| lives | integer | Number of covered lives. |
| notes | string | The policy's own notes field. |
| status* | string | |
| carrier* | string | The carrier's full name. |
| premium | number | Premium amount. |
| entity_id* | integer | The groupID or individualID that holds the policy. |
| term_date | string | A date, yyyy-mm-dd. |
| entity_type* | string | |
| renewal_date | string | A date, yyyy-mm-dd. |
| coverage_type |
Activities by id (1-50 ids), e.g. the ids shown on a policy or individual. POST activity/list.
| Argument | Type | Description |
|---|---|---|
| activity_ids* | array |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"activity_ids"
],
"properties": {
"activity_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 50,
"minItems": 1
}
}
}One agent by id, with agencies, addresses and custom fields (and activities when include_activities is true). POST agents/detail.
| Argument | Type | Description |
|---|---|---|
| agent_id* | integer | |
| include_activities | boolean | Also return the activities (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"agent_id"
],
"properties": {
"agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"include_activities": {
"type": "boolean",
"description": "Also return the activities (default false)."
}
}
}One group by id, with addresses, policies and custom fields (and activities when include_activities is true). POST groups/detail.
| Argument | Type | Description |
|---|---|---|
| group_id* | integer | |
| include_activities | boolean | Also return the activities (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"group_id"
],
"properties": {
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"include_activities": {
"type": "boolean",
"description": "Also return the activities (default false)."
}
}
}One individual by id, with addresses, policies and custom fields (and activities when include_activities is true). National ids are removed. POST individuals/detail.
| Argument | Type | Description |
|---|---|---|
| individual_id* | integer | |
| include_activities | boolean | Also return the activities (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"individual_id"
],
"properties": {
"individual_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"include_activities": {
"type": "boolean",
"description": "Also return the activities (default false)."
}
}
}One Sales Enablement record (lead) by record id. POST salesEnablement/Leads/detail.
| Argument | Type | Description |
|---|---|---|
| record_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"record_id"
],
"properties": {
"record_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}One policy by id: holder, agent, carrier, status, dates, premium, coverages and custom fields. POST policies/detail.
| Argument | Type | Description |
|---|---|---|
| policy_id* | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"policy_id"
],
"properties": {
"policy_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}All activities (tasks, calls, renewals) logged on one group, individual, agent, carrier or lead: date, subject, notes, status, type, method, priority and follow-up. There is no paging. POST activities/list.
| Argument | Type | Description |
|---|---|---|
| entity_id* | integer | Id of the record. |
| entity_type* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_id",
"entity_type"
],
"properties": {
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record.",
"exclusiveMinimum": 0
},
"entity_type": {
"enum": [
"Group",
"Individual",
"Agent",
"Carrier",
"Lead"
],
"type": "string"
}
}
}Notes (subject, body, author, dates, pinned flag, attachment names) on one agent, group, individual or policy, newest change first. There is no paging. POST notes/list.
| Argument | Type | Description |
|---|---|---|
| entity_id* | integer | Id of the record. |
| entity_type* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_id",
"entity_type"
],
"properties": {
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the record.",
"exclusiveMinimum": 0
},
"entity_type": {
"enum": [
"Agent",
"Group",
"Individual",
"Policy"
],
"type": "string"
}
}
}Search agents (producers) by name, email or phone. Returns id, name, email and phones. POST agents/search.
| Argument | Type | Description |
|---|---|---|
| string | ||
| limit | integer | Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist. |
| phone | string | Matches the home, cell or business phone. |
| last_name | string | |
| first_name | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"limit": {
"type": "integer",
"maximum": 500,
"description": "Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist.",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Matches the home, cell or business phone."
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
}
}Search insurance carriers by name or phone. Returns id, name, abbreviation and phones. POST carriers/search.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist. |
| phone | string | Matches any carrier phone. |
| carrier_name | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"description": "Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist.",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Matches any carrier phone."
},
"carrier_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
}
}Search groups (employer / business accounts) in AgencyBloc by name, type or phone. Returns id, name, type and phone. POST groups/search.
| Argument | Type | Description |
|---|---|---|
| type | string | The group type as configured in the account. |
| limit | integer | Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist. |
| group_name | string | |
| updated_since | string | Only groups modified on/after this date. |
| business_phone | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The group type as configured in the account."
},
"limit": {
"type": "integer",
"maximum": 500,
"description": "Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist.",
"exclusiveMinimum": 0
},
"group_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"updated_since": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Only groups modified on/after this date."
},
"business_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
}
}
}Search individuals (clients and contacts) in AgencyBloc. All filters are optional and combine; with none you get the first records. Returns id, name, email, birth date, phones and last-updated time (national ids such as SSN are never returned). Use updated_since to find recently changed people. POST individuals/search.
| Argument | Type | Description |
|---|---|---|
| string | ||
| limit | integer | Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist. |
| phone | string | Matches the home, cell or business phone. |
| group_id | integer | Only members of this group. |
| last_name | string | |
| first_name | string | |
| updated_since | string | Only records updated on/after this (inclusive); results then run oldest update first. |
| updated_before | string | Only records updated before this (exclusive). |
Find Sales Enablement records (leads) by phone number; the search is by phone only. Only accounts with the Sales Enablement module have them. POST salesEnablement/leads/searchphone.
| Argument | Type | Description |
|---|---|---|
| phone* | string | Phone number to look up. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"phone"
],
"properties": {
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Phone number to look up."
}
}
}Search policies by number, coverage type, carrier, holder, servicing agent, application date or last update. Returns id, holder, policy number, carrier, status, coverage type, effective and renewal dates. Use submitted_after/updated_since for recent business. POST policies/search.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist. |
| carrier | string | Carrier name. |
| entity_id | integer | Holder id (group or individual id); give entity_type too. |
| entity_type | string | Whether entity_id is a Group or an Individual. |
| coverage_type | string | Coverage type as configured in the account (e.g. Medicare Supplement). |
| policy_number | string | |
| updated_since | string | Only records updated on/after this (inclusive); results then run oldest update first. |
| updated_before | string | Only records updated before this (exclusive). |
WRITE: change fields of an existing group (including its name); fields you leave out are not sent. Returns the groupID. POST groups/update.
| Argument | Type | Description |
|---|---|---|
| dba | string | Doing-business-as name. |
| type | string | Group type as configured in the account. |
| website | string | |
| group_id* | integer | |
| industry | string | |
| employees | integer | Number of employees. |
| group_name | string | |
| description | string | |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| business_phone |
WRITE: change fields of an existing individual; fields you leave out are not sent. Tags are replaced (empty string clears them). Addresses are not changed here. Returns the individualID. POST individuals/update.
| Argument | Type | Description |
|---|---|---|
| tags | string | Tags (replaces existing tags on update; an empty string clears them). |
| type | string | Type as configured in the account; an unknown value is created. |
| string | ||
| gender | string | |
| status | string | Status as configured in the account; an unknown value is created. |
| group_id | integer | Group the individual belongs to. |
| birth_date | string | A date, yyyy-mm-dd. |
| cell_phone | string | |
| home_phone | string | |
| lead_source |
WRITE: change fields of an existing policy (status, carrier, dates, premium ...); fields you leave out are not sent. Returns the policyID. POST policies/update.
| Argument | Type | Description |
|---|---|---|
| lives | integer | Number of covered lives. |
| notes | string | The policy's own notes field. |
| status | string | |
| carrier | string | |
| premium | number | Premium amount. |
| policy_id* | integer | |
| term_date | string | A date, yyyy-mm-dd. |
| renewal_date | string | A date, yyyy-mm-dd. |
| coverage_type | string | |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| string |
| description | string |
| address_type | string | Address label (e.g. Home, Business, Mailing); used with the address fields below. |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| business_phone | string |
| account_manager | string | A user id or the exact user name in AgencyBloc. |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"group_name"
],
"properties": {
"dba": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Doing-business-as name."
},
"zip": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"type": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Group type as configured in the account."
},
"state": {
"type": "string",
"maxLength": 2,
"minLength": 1,
"description": "Two-letter state abbreviation."
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"street1": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"street2": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"website": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"industry": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"employees": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Number of employees."
},
"group_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"address_type": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Address label (e.g. Home, Business, Mailing); used with the address fields below."
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"business_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"account_manager": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A user id or the exact user name in AgencyBloc."
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}| integer |
| Group the individual belongs to. |
| last_name* | string |
| birth_date | string | A date, yyyy-mm-dd. |
| cell_phone | string |
| first_name* | string |
| home_phone | string |
| lead_source | string |
| address_type | string | Address label (e.g. Home, Business, Mailing); used with the address fields below. |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| business_phone | string |
| middle_initial | string |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"first_name",
"last_name"
],
"properties": {
"zip": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"city": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"tags": {
"type": "string",
"maxLength": 500,
"description": "Tags (replaces existing tags on update; an empty string clears them)."
},
"type": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Type as configured in the account; an unknown value is created."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3
},
"state": {
"type": "string",
"maxLength": 2,
"minLength": 1,
"description": "Two-letter state abbreviation."
},
"gender": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Status as configured in the account; an unknown value is created."
},
"street1": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"street2": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Group the individual belongs to.",
"exclusiveMinimum": 0
},
"last_name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"birth_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"cell_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"home_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"lead_source": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"address_type": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Address label (e.g. Home, Business, Mailing); used with the address fields below."
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"business_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"middle_initial": {
"type": "string",
"maxLength": 5,
"minLength": 1
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}| string |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| pay_frequency | string | Payment frequency as configured in the account (e.g. Monthly). |
| policy_number | string |
| effective_date | string | A date, yyyy-mm-dd. |
| app_submit_date | string | A date, yyyy-mm-dd. |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"entity_id",
"entity_type",
"coverage_type",
"status",
"carrier"
],
"properties": {
"lives": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Number of covered lives."
},
"notes": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "The policy's own notes field."
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"carrier": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The carrier's full name."
},
"premium": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Premium amount."
},
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "The groupID or individualID that holds the policy.",
"exclusiveMinimum": 0
},
"term_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"entity_type": {
"enum": [
"Group",
"Individual"
],
"type": "string"
},
"renewal_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"coverage_type": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"pay_frequency": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Payment frequency as configured in the account (e.g. Monthly)."
},
"policy_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"effective_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"app_submit_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"limit": {
"type": "integer",
"maximum": 500,
"description": "Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist.",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 1,
"description": "Matches the home, cell or business phone."
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only members of this group.",
"exclusiveMinimum": 0
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"updated_since": {
"type": "string",
"description": "Only records updated on/after this (inclusive); results then run oldest update first."
},
"updated_before": {
"type": "string",
"description": "Only records updated before this (exclusive)."
}
}
}| submitted_after | string | Application submitted on/after this date. |
| submitted_before | string | Application submitted on/before this date (AgencyBloc includes the date itself). |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"description": "Most records to return, 1-500 (default 50). There is no paging: narrow with filters if more may exist.",
"exclusiveMinimum": 0
},
"carrier": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Carrier name."
},
"entity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Holder id (group or individual id); give entity_type too.",
"exclusiveMinimum": 0
},
"entity_type": {
"enum": [
"Group",
"Individual"
],
"type": "string",
"description": "Whether entity_id is a Group or an Individual."
},
"coverage_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Coverage type as configured in the account (e.g. Medicare Supplement)."
},
"policy_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"updated_since": {
"type": "string",
"description": "Only records updated on/after this (inclusive); results then run oldest update first."
},
"updated_before": {
"type": "string",
"description": "Only records updated before this (exclusive)."
},
"submitted_after": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Application submitted on/after this date."
},
"submitted_before": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Application submitted on/before this date (AgencyBloc includes the date itself)."
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}| string |
| account_manager | string | A user id or the exact user name in AgencyBloc. |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"group_id"
],
"properties": {
"dba": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Doing-business-as name."
},
"type": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Group type as configured in the account."
},
"website": {
"type": "string",
"maxLength": 300,
"minLength": 1
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"industry": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"employees": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Number of employees."
},
"group_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"description": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"business_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"account_manager": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "A user id or the exact user name in AgencyBloc."
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}| string |
| custom_fields | object | Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||. |
| individual_id* | integer |
| business_phone | string |
| middle_initial | string |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"individual_id"
],
"properties": {
"tags": {
"type": "string",
"maxLength": 500,
"description": "Tags (replaces existing tags on update; an empty string clears them)."
},
"type": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Type as configured in the account; an unknown value is created."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3
},
"gender": {
"type": "string",
"maxLength": 20,
"minLength": 1
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Status as configured in the account; an unknown value is created."
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Group the individual belongs to.",
"exclusiveMinimum": 0
},
"birth_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"cell_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"home_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"lead_source": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"individual_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"business_phone": {
"type": "string",
"maxLength": 40,
"minLength": 1
},
"middle_initial": {
"type": "string",
"maxLength": 5,
"minLength": 1
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}| pay_frequency | string | Payment frequency as configured in the account (e.g. Monthly). |
| policy_number | string |
| effective_date | string | A date, yyyy-mm-dd. |
| app_submit_date | string | A date, yyyy-mm-dd. |
| servicing_agent_id | integer |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"policy_id"
],
"properties": {
"lives": {
"type": "integer",
"maximum": 10000000,
"minimum": 0,
"description": "Number of covered lives."
},
"notes": {
"type": "string",
"maxLength": 4000,
"minLength": 1,
"description": "The policy's own notes field."
},
"status": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"carrier": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"premium": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Premium amount."
},
"policy_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"term_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"renewal_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"coverage_type": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"custom_fields": {
"type": "object",
"description": "Custom field values keyed by the exact custom field NAME configured in AgencyBloc (sent as custom_<name>). Separate several values of a checkbox-list field with ||.",
"propertyNames": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"additionalProperties": {
"type": "string",
"maxLength": 2000
}
},
"pay_frequency": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Payment frequency as configured in the account (e.g. Monthly)."
},
"policy_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"effective_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"app_submit_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"servicing_agent_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
}
}