openapi: 3.0.1
info:
title: Broker and Insured Marketing Data v2
description: "<b>Broker and Insured Marketing Data</b> API. This API provides marketing details for Beazley's partner organisations. Please use the sandbox version of this API for initial development and testing. The current version of this API is V2.<br><br>\r\n\r\nPlease contact <a href=\"mailto:ITArchitecture@Beazley.com?Subject=MarketingData\">\r\nITArchitecture@Beazley.com</a> if you have any questions about this API."
version: '1.0'
servers:
- url: https://api.beazley.com/marketing/v2
paths:
/contacts/:
post:
summary: contact (POST)
operationId: 562e100f809792165c5ef921
parameters:
- name: ProviderID
in: query
required: true
schema:
type: string
requestBody:
description: "<h4>Model</h4>\n<pre>\nContact \n{\n EmailAddress (string, required): <font color=\"brown\">Email address of the contact,</font>\n FirstName (string, required): <font color=\"brown\">Given name of the contact,</font>\n LastName (string, required): <font color=\"brown\">Surname of the contact,</font>\n OrganisationId (string, required): <font color=\"brown\">id of the organisation linked to the contact,</font>\n JobTitle (string, optional): <font color=\"brown\">Job title of the contact,</font>\n MobilePhoneNumber (string, optional): <font color=\"brown\">Mobile telephone number of the contact,</font>\n TelephoneNumber (string, optional): <font color=\"brown\">Groundline telephone number of the contact,</font>\n CreatedOn (datetime, optional): <font color=\"brown\">Creation date (ISO 8601),</font>\n IsActive (boolean, optional): <font color=\"brown\">Active indicator,</font>\n Industry (string, optional): <font color=\"brown\">Industry description,</font>\n FocusArea (string, optional): <font color=\"brown\">Focus area.</font>\n}\n</pre>"
content:
application/json:
example:
Contact:
EmailAddress: rita.foster79@example.com
FirstName: Rita
LastName: Foster
OrganisationId: 9a89d986-f907-4b7b-87c3-50aac2040c64
JobTitle: Health Inspector
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
CreatedOn: '2014-10-20'
IsActive: true
Industry: Education
FocusArea: Risk Management
responses:
'200':
description: ''
content:
application/json:
example:
Id: 4254e883-55f5-e411-80ff-0050568e7c76
'/Contacts/{id}':
put:
summary: contact (PUT)
operationId: 562e100f809792165c5ef922
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
required: true
schema:
type: string
requestBody:
description: "<h4>Model</h4>\n<pre>\nContact \n{\n EmailAddress (string, required): <font color=\"brown\">Email address of the contact,</font>\n FirstName (string, required): <font color=\"brown\">Given name of the contact,</font>\n LastName (string, required): <font color=\"brown\">Surname of the contact,</font>\n OrganisationId (string, required): <font color=\"brown\">id of the organisation linked to the contact,</font>\n JobTitle (string, optional): <font color=\"brown\">Job title of the contact,</font>\n MobilePhoneNumber (string, optional): <font color=\"brown\">Mobile telephone number of the contact,</font>\n TelephoneNumber (string, optional): <font color=\"brown\">Groundline telephone number of the contact,</font>\n CreatedOn (datetime, optional): <font color=\"brown\">Creation date (ISO 8601),</font>\n IsActive (boolean, optional): <font color=\"brown\">Active indicator,</font>\n Industry (string, optional): <font color=\"brown\">Industry description,</font>\n FocusArea (string, optional): <font color=\"brown\">Focus area.</font>\n}\n</pre>"
content:
application/json:
example:
Contact:
EmailAddress: rita.foster79@example.com
FirstName: Rita
LastName: Foster
JobTitle: Health Inspector
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
IsActive: true
Industry: Education
FocusArea: Risk Management
responses:
'200':
description: ''
'/contacts/{id}':
get:
summary: contact by id (GET)
operationId: 562e100f809792165c5ef923
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nContacts\n{\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the contact,</font>\n \"EmailAddress\" (string, <b>required</b>): <font color=\"brown\">Email address of the contact,</font>\n \"FirstName\" (string, <b>required</b>): <font color=\"brown\">Given name of the contact,</font>\n \"JobTitle\" (string, <b>optional</b>): <font color=\"brown\">Job title of the contact,</font>\n \"LastName\" (string, <b>required</b>): <font color=\"brown\">Surname of the contact,</font>\n \"MobilePhoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Mobile telephone number of the contact,</font>\n \"TelephoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Groundline telephone number of the contact,</font>\n \"CreatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was created,</font>\n \"UpdatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was last updated,</font>\n \"OrganisationId\" (string, <b>required</b>): <font color=\"brown\">id of the organisation linked to the contact,</font>\n \"IsActive\" (boolean, <b>optional</b>): <font color=\"brown\">Active indicator,</font>\n \"Industry\" (string, <b>optional</b>): <font color=\"brown\">Industry description,</font>\n \"FocusArea\" (string, optional): <font color=\"brown\">Focus area.</font>\n \"MicroSiteSubscriptions\": \n [\n {\n \"SubscriberId\" (string, <b>optional</b>): <font color=\"brown\">Unique id of the microsite subscription,</font>\n \"MicroSite\": \n {\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the microsite,</font>\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the microsite</font> \n },\n \"StartDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription starts,</font>\n \"EndDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription ends,</font>\n \"PolicyType\" (string, <b>optional</b>): <font color=\"brown\">The policy renewal status: 0 for new, 1 for renewal,</font>\n }\n ]\n}\n</pre>"
content:
application/json:
example:
PageNumber: 1
Contacts:
- Id: 50f80afd-7fee-e411-80ff-0050568e7c76
EmailAddress: rita.foster79@example.com
FirstName: Rita
JobTitle: Health Inspector
LastName: Foster
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
CreatedOn: '2015-04-29T14:57:08.0000000+00:00'
UpdatedOn: '2015-04-29T14:58:47.0000000+00:00'
OrganisationId: 838a6fce-a2ed-e411-80ff-0050568e7c76
IsActive: true
Industry: Technology
FocusArea: Risk Management
MicroSiteSubscriptions:
- SubscriberId: 50f80afd-7fee-e411-80ff-0050568e7c76
MicroSite:
Id: 861d97ca-fdee-e411-80ff-0050568e7c76
Name: Breach Solutions
StartDate: '2015-03-31T23:00:00.0000000+00:00'
EndDate: '2016-03-31T23:00:00.0000000+00:00'
PolicyType: 0
/contacts:
get:
summary: contacts (GET)
operationId: 562e100f809792165c5ef924
parameters:
- name: ProviderID
in: query
description: Your unique provider ID
required: true
schema:
type: string
- name: UpdatedSince
in: query
description: Returns records updated since this date
schema:
type: string
- name: PageNumber
in: query
description: Returns the results from page N
schema:
enum:
- '1'
type: string
- name: RecordsPerPage
in: query
description: Sets the number of results per page. Maximum of 400
schema:
enum:
- '400'
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nContacts\n{\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the contact,</font>\n \"EmailAddress\" (string, <b>required</b>): <font color=\"brown\">Email address of the contact,</font>\n \"FirstName\" (string, <b>required</b>): <font color=\"brown\">Given name of the contact,</font>\n \"JobTitle\" (string, <b>optional</b>): <font color=\"brown\">Job title of the contact,</font>\n \"LastName\" (string, <b>required</b>): <font color=\"brown\">Surname of the contact,</font>\n \"MobilePhoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Mobile telephone number of the contact,</font>\n \"TelephoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Groundline telephone number of the contact,</font>\n \"CreatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was created,</font>\n \"UpdatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was last updated,</font>\n \"OrganisationId\" (string, <b>required</b>): <font color=\"brown\">id of the organisation linked to the contact,</font>\n \"IsActive\" (boolean, <b>optional</b>): <font color=\"brown\">Active indicator,</font>\n \"Industry\" (string, <b>optional</b>): <font color=\"brown\">Industry description,</font>\n \"FocusArea\" (string, optional): <font color=\"brown\">Focus area.</font>\n \"MicroSiteSubscriptions\": \n [\n {\n \"SubscriberId\" (string, <b>optional</b>): <font color=\"brown\">Unique id of the microsite subscription,</font>\n \"MicroSite\": \n {\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the microsite,</font>\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the microsite</font> \n },\n \"StartDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription starts,</font>\n \"EndDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription ends,</font>\n \"PolicyType\" (string, <b>optional</b>): <font color=\"brown\">The policy renewal status: 0 for new, 1 for renewal,</font>\n }\n ]\n}\n</pre>"
content:
application/json:
example:
PageNumber: 1
Contacts:
- Id: 50f80afd-7fee-e411-80ff-0050568e7c76
EmailAddress: rita.foster79@example.com
FirstName: Rita
JobTitle: Health Inspector
LastName: Foster
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
CreatedOn: '2015-04-29T14:57:08.0000000+00:00'
UpdatedOn: '2015-04-29T14:58:47.0000000+00:00'
OrganisationId: 838a6fce-a2ed-e411-80ff-0050568e7c76
IsActive: true
Industry: Technology
FocusArea: Risk Management
MicroSiteSubscriptions:
- SubscriberId: 50f80afd-7fee-e411-80ff-0050568e7c76
MicroSite:
Id: 861d97ca-fdee-e411-80ff-0050568e7c76
Name: Breach Solutions
StartDate: '2015-03-31T23:00:00.0000000+00:00'
EndDate: '2016-03-31T23:00:00.0000000+00:00'
PolicyType: 0
'/microsites/{id}/contacts':
get:
summary: contacts by microsite (GET)
operationId: 562e100f809792165c5ef925
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
required: true
schema:
type: string
- name: UpdatedSince
in: query
schema:
type: string
- name: PageNumber
in: query
schema:
type: string
- name: RecordsPerPage
in: query
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nContacts\n{\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the contact,</font>\n \"EmailAddress\" (string, <b>required</b>): <font color=\"brown\">Email address of the contact,</font>\n \"FirstName\" (string, <b>required</b>): <font color=\"brown\">Given name of the contact,</font>\n \"JobTitle\" (string, <b>optional</b>): <font color=\"brown\">Job title of the contact,</font>\n \"LastName\" (string, <b>required</b>): <font color=\"brown\">Surname of the contact,</font>\n \"MobilePhoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Mobile telephone number of the contact,</font>\n \"TelephoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Groundline telephone number of the contact,</font>\n \"CreatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was created,</font>\n \"UpdatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was last updated,</font>\n \"OrganisationId\" (string, <b>required</b>): <font color=\"brown\">id of the organisation linked to the contact,</font>\n \"IsActive\" (boolean, <b>optional</b>): <font color=\"brown\">Active indicator,</font>\n \"Industry\" (string, <b>optional</b>): <font color=\"brown\">Industry description,</font>\n \"FocusArea\" (string, optional): <font color=\"brown\">Focus area,</font>\n \"MicroSiteSubscriptions\": \n [\n {\n \"SubscriberId\" (string, <b>optional</b>): <font color=\"brown\">Unique id of the microsite subscription,</font>\n \"MicroSite\": \n {\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the microsite,</font>\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the microsite</font> \n },\n \"StartDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription starts,</font>\n \"EndDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription ends,</font>\n \"PolicyType\" (string, <b>optional</b>): <font color=\"brown\">The policy renewal status: 0 for new, 1 for renewal,</font>\n }\n ]\n}\n</pre>"
content:
application/json:
example:
PageNumber: 1
Contacts:
- Id: 50f80afd-7fee-e411-80ff-0050568e7c76
EmailAddress: rita.foster79@example.com
FirstName: Rita
JobTitle: Health Inspector
LastName: Foster
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
CreatedOn: '2015-04-29T14:57:08.0000000+00:00'
UpdatedOn: '2015-04-29T14:58:47.0000000+00:00'
OrganisationId: 838a6fce-a2ed-e411-80ff-0050568e7c76
IsActive: true
Industry: Technology
FocusArea: Risk Management
MicroSiteSubscriptions:
- SubscriberId: 50f80afd-7fee-e411-80ff-0050568e7c76
MicroSite:
Id: 861d97ca-fdee-e411-80ff-0050568e7c76
Name: Breach Solutions
StartDate: '2015-03-31T23:00:00.0000000+00:00'
EndDate: '2016-03-31T23:00:00.0000000+00:00'
PolicyType: 0
'/organisations/{id}/contacts':
get:
summary: contacts by organisation (GET)
operationId: 562e100f809792165c5ef926
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
required: true
schema:
type: string
- name: UpdatedSince
in: query
schema:
type: string
- name: PageNumber
in: query
schema:
type: string
- name: RecordsPerPage
in: query
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nContacts\n{\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the contact,</font>\n \"EmailAddress\" (string, <b>required</b>): <font color=\"brown\">Email address of the contact,</font>\n \"FirstName\" (string, <b>required</b>): <font color=\"brown\">Given name of the contact,</font>\n \"JobTitle\" (string, <b>optional</b>): <font color=\"brown\">Job title of the contact,</font>\n \"LastName\" (string, <b>required</b>): <font color=\"brown\">Surname of the contact,</font>\n \"MobilePhoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Mobile telephone number of the contact,</font>\n \"TelephoneNumber\" (string, <b>optional</b>): <font color=\"brown\">Groundline telephone number of the contact,</font>\n \"CreatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was created,</font>\n \"UpdatedOn\" (string, <b>required</b>): <font color=\"brown\">Date time that the contact record was last updated,</font>\n \"OrganisationId\" (string, <b>required</b>): <font color=\"brown\">id of the organisation linked to the contact,</font>\n \"IsActive\" (boolean, <b>optional</b>): <font color=\"brown\">Active indicator,</font>\n \"Industry\" (string, <b>optional</b>): <font color=\"brown\">Industry description,</font>\n \"FocusArea\" (string, optional): <font color=\"brown\">Focus area,</font>\n \"MicroSiteSubscriptions\": \n [\n {\n \"SubscriberId\" (string, <b>optional</b>): <font color=\"brown\">Unique id of the microsite subscription,</font>\n \"MicroSite\": \n {\n \"Id\" (string, <b>required</b>): <font color=\"brown\">Unique id of the microsite,</font>\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the microsite</font> \n },\n \"StartDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription starts,</font>\n \"EndDate\" (string, <b>optional</b>): <font color=\"brown\">Date time that the subscription ends,</font>\n \"PolicyType\" (string, <b>optional</b>): <font color=\"brown\">The policy renewal status: 0 for new, 1 for renewal,</font>\n }\n ]\n}\n</pre>"
content:
application/json:
example:
PageNumber: 1
Contacts:
- Id: 50f80afd-7fee-e411-80ff-0050568e7c76
EmailAddress: rita.foster79@example.com
FirstName: Rita
JobTitle: Health Inspector
LastName: Foster
MobilePhoneNumber: (859)-931-4822
TelephoneNumber: (484)-496-6034
CreatedOn: '2015-04-29T14:57:08.0000000+00:00'
UpdatedOn: '2015-04-29T14:58:47.0000000+00:00'
OrganisationId: 838a6fce-a2ed-e411-80ff-0050568e7c76
IsActive: true
Industry: Technology
FocusArea: Risk Management
MicroSiteSubscriptions:
- SubscriberId: 50f80afd-7fee-e411-80ff-0050568e7c76
MicroSite:
Id: 861d97ca-fdee-e411-80ff-0050568e7c76
Name: Breach Solutions
StartDate: '2015-03-31T23:00:00.0000000+00:00'
EndDate: '2016-03-31T23:00:00.0000000+00:00'
PolicyType: 0
/microsites/:
get:
summary: microsites (GET)
operationId: 562e100f809792165c5ef927
parameters:
- name: ProviderID
in: query
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
example:
- Id: e3af7404-9d73-44d2-b5c1-2b4785ad8130
Name: NoDataBreach.com
'/organisations/{id}':
put:
summary: organisation (PUT)
operationId: 562e100f809792165c5ef928
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
required: true
schema:
type: string
requestBody:
description: "<h4>Model</h4>\n<pre>\nOrganisations\n{\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the organisation,</font>\n \"NAICSCode\" (string, <b>required</b>): <font color=\"brown\">NAICS classification code of the organisation,</font>\n \"Address\" (string, <b>required</b>): <font color=\"brown\">Primary address of the organisation,</font>\n {\n \"CityTown\": \"Cambridge\",\n \"Country\": \"United States\",\n \"FloorOrSuite\": \"2\",\n \"Line1\": \"12345 Main Street\",\n \"Line2\": \"Suite 125\",\n \"Line3\": null,\n \"StateCountyProvince\": \"MA\",\n \"PostZipCode\": \"02139\"\n },\n \"IsActive\" (string, <b>optional</b>): <font color=\"brown\">Organisation active indicator,</font>\n}\n</pre>"
content:
application/json:
example:
Organisation:
Name: Rook Industries
NAICSCode: '541618'
IsActive: 'True'
Address:
CityTown: Cambridge
Country: United States
FloorOrSuite: '2'
Line1: 77 Massachusetts Avenue
Line2: Building A
Line3: ''
StateCountyProvince: MA
PostZipCode: '02139'
responses:
'200':
description: ''
get:
summary: organisation by id (GET)
operationId: 562e100f809792165c5ef929
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: ProviderID
in: query
description: Your unique provider ID
required: true
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nOrganisations\n{\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the organisation,</font>\n \"NAICSCode\" (string, <b>required</b>): <font color=\"brown\">NAICS classification code of the organisation,</font>\n \"Address\" (string, <b>required</b>): <font color=\"brown\">Primary address of the organisation,</font>\n {\n \"CityTown\": \"Cambridge\",\n \"Country\": \"United States\",\n \"FloorOrSuite\": \"2\",\n \"Line1\": \"12345 Main Street\",\n \"Line2\": \"Suite 125\",\n \"Line3\": null,\n \"StateCountyProvince\": \"MA\",\n \"PostZipCode\": \"02139\"\n },\n \"IsActive\" (string, <b>optional</b>): <font color=\"brown\">Organisation active indicator,</font>\n}\n</pre>"
content:
application/json:
example:
- Organisation:
Id: 4781dc2e-d980-4a32-8158-937a06423005
MarketSegment: 1
Name: Rook Industries
NAICSCode: '541618'
AccessCode: touqng
ThirdPartyOrgRef: ABC123XYZ
Domain: www.rook.com
IsActive: true
Programs:
- Name: BBR Select
Address:
CityTown: Cambridge
Country: United States
FloorOrSuite: '2'
Line1: 77 Massachusetts Avenue
Line2: Building A
Line3: ''
StateCountyProvince: MA
PostZipCode: '02139'
/organisations:
get:
summary: organisations (GET)
operationId: 562e100f809792165c5ef92a
parameters:
- name: ProviderID
in: query
description: Your unique provider ID
required: true
schema:
type: string
- name: UpdatedSince
in: query
description: Returns records updated since this date
schema:
type: string
- name: PageNumber
in: query
description: Returns the results from page N
schema:
enum:
- '1'
type: string
- name: RecordsPerPage
in: query
description: Sets the number of results per page. Maximum of 400
schema:
enum:
- '400'
type: string
- name: AccessCode
in: query
description: Returns records that match a specific access code
schema:
type: string
- name: Domain
in: query
description: Returns records that match a specific domain
schema:
type: string
- name: ThirdPartyOrgRef
in: query
description: Returns records that match a specific third party ID
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nOrganisations\n{\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the organisation,</font>\n \"NAICSCode\" (string, <b>required</b>): <font color=\"brown\">NAICS classification code of the organisation,</font>\n \"Address\" (string, <b>required</b>): <font color=\"brown\">Primary address of the organisation,</font>\n {\n \"CityTown\": \"Cambridge\",\n \"Country\": \"United States\",\n \"FloorOrSuite\": \"2\",\n \"Line1\": \"12345 Main Street\",\n \"Line2\": \"Suite 125\",\n \"Line3\": null,\n \"StateCountyProvince\": \"MA\",\n \"PostZipCode\": \"02139\"\n },\n \"IsActive\" (string, <b>optional</b>): <font color=\"brown\">Organisation active indicator,</font>\n}\n</pre>"
content:
application/json:
example:
- Organisation:
Id: 4781dc2e-d980-4a32-8158-937a06423005
MarketSegment: 1
Name: Rook Industries
NAICSCode: '541618'
AccessCode: touqng
ThirdPartyOrgRef: ABC123XYZ
Domain: www.rook.com
IsActive: true
Programs:
- Name: BBR Select
Address:
CityTown: Cambridge
Country: United States
FloorOrSuite: '2'
Line1: 77 Massachusetts Avenue
Line2: Building A
Line3: ''
StateCountyProvince: MA
PostZipCode: '02139'
'/microsites/{id}/organisations':
get:
summary: organisations by microsite (GET)
operationId: 562e100f809792165c5ef92b
parameters:
- name: id
in: path
description: Microsite ID
required: true
schema:
type: string
- name: ProviderID
in: query
description: Your unique provider ID
required: true
schema:
type: string
- name: UpdatedSince
in: query
description: Returns records updated since this date
schema:
type: string
- name: PageNumber
in: query
description: Returns the results from page N
schema:
enum:
- '1'
type: string
- name: RecordsPerPage
in: query
description: Sets the number of results per page. Maximum of 400
schema:
enum:
- '400'
type: string
- name: AccessCode
in: query
description: Returns records that match a specific access code
schema:
type: string
responses:
'200':
description: "<h4>Model</h4>\n<pre>\nOrganisations\n{\n \"Name\" (string, <b>required</b>): <font color=\"brown\">Name of the organisation,</font>\n \"NAICSCode\" (string, <b>required</b>): <font color=\"brown\">NAICS classification code of the organisation,</font>\n \"Address\" (string, <b>required</b>): <font color=\"brown\">Primary address of the organisation,</font>\n {\n \"CityTown\": \"Cambridge\",\n \"Country\": \"United States\",\n \"FloorOrSuite\": \"2\",\n \"Line1\": \"12345 Main Street\",\n \"Line2\": \"Suite 125\",\n \"Line3\": null,\n \"StateCountyProvince\": \"MA\",\n \"PostZipCode\": \"02139\"\n },\n \"IsActive\" (string, <b>optional</b>): <font color=\"brown\">Organisation active indicator,</font>\n}\n</pre>"
content:
application/json:
example:
- Organisation:
Id: 4781dc2e-d980-4a32-8158-937a06423005
MarketSegment: 1
Name: Rook Industries
NAICSCode: '541618'
AccessCode: touqng
ThirdPartyOrgRef: ABC123XYZ
Domain: www.rook.com
IsActive: true
Programs:
- Name: BBR Select
Address:
CityTown: Cambridge
Country: United States
FloorOrSuite: '2'
Line1: 77 Massachusetts Avenue
Line2: Building A
Line3: ''
StateCountyProvince: MA
PostZipCode: '02139'
/ping/:
get:
summary: ping (GET)
description: Validation call to confirm that you can connect to the API.
operationId: 562e100f809792165c5ef92c
responses:
'200':
description: ''
content:
text/plain:
example: Achievement Unlocked. You have successfully called the Beazley Marketing API.
'/organisations/{id}/organisations':
post:
summary: organisations (POST)
operationId: 57457b318097920fc0486734
parameters:
- name: id
in: path
description: the key of the ‘parent’ organisation
required: true
schema:
type: string
requestBody:
description: "<h4>Model</h4>\n<pre>\nOrganisations\n[\n {\n \"Name\" (string, required): <font color=\"brown\">Name of the organisati
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/beazley/refs/heads/main/openapi/beazley-broker-and-insured-marketing-data-v2.yml