openapi: 3.0.1 info: title: Broker and Insured Marketing Data v2 (Sandbox) description: "A sandbox version of the Broker and Insured Marketing Data v2 API. This API provides marketing details for Beazley's partner organisations.

\n\nPlease contact \nITArchitecture@Beazley.com if you have any questions about this API." version: '1.0' servers: - url: https://api.beazley.com/sandbox/marketing/v2 paths: /contacts/: post: summary: contact (POST) operationId: 561e208f8097920ed881e636 parameters: - name: ProviderID in: query required: true schema: type: string requestBody: description: "

Model

\nContact \n{\n     EmailAddress (string, required): Email address of the contact,\n     FirstName (string, required): Given name of the contact,\n     LastName (string, required): Surname of the contact,\n     OrganisationId (string, required): id of the organisation linked to the contact,\n     JobTitle (string, optional): Job title of the contact,\n     MobilePhoneNumber (string, optional): Mobile telephone number of the contact,\n     TelephoneNumber (string, optional): Groundline telephone number of the contact,\n     CreatedOn (datetime, optional): Creation date (ISO 8601),\n     IsActive (boolean, optional): Active indicator,\n     Industry (string, optional): Industry description,\n     FocusArea (string, optional): Focus area.\n}\n

" 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: 561e208f8097920ed881e637 parameters: - name: id in: path required: true schema: type: string - name: ProviderID in: query required: true schema: type: string requestBody: description: "

Model

\nContact \n{\n     EmailAddress (string, required): Email address of the contact,\n     FirstName (string, required): Given name of the contact,\n     LastName (string, required): Surname of the contact,\n     OrganisationId (string, required): id of the organisation linked to the contact,\n     JobTitle (string, optional): Job title of the contact,\n     MobilePhoneNumber (string, optional): Mobile telephone number of the contact,\n     TelephoneNumber (string, optional): Groundline telephone number of the contact,\n     CreatedOn (datetime, optional): Creation date (ISO 8601),\n     IsActive (boolean, optional): Active indicator,\n     Industry (string, optional): Industry description,\n     FocusArea (string, optional): Focus area.\n}\n

" 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: 561e208f8097920ed881e638 parameters: - name: id in: path required: true schema: type: string - name: ProviderID in: query schema: type: string responses: '200': description: "

Model

\nContacts\n{\n     \"Id\" (string, required): Unique id of the contact,\n     \"EmailAddress\" (string, required): Email address of the contact,\n     \"FirstName\" (string, required): Given name of the contact,\n     \"JobTitle\" (string, optional): Job title of the contact,\n     \"LastName\" (string, required): Surname of the contact,\n     \"MobilePhoneNumber\" (string, optional): Mobile telephone number of the contact,\n     \"TelephoneNumber\" (string, optional): Groundline telephone number of the contact,\n     \"CreatedOn\" (string, required): Date time that the contact record was created,\n     \"UpdatedOn\" (string, required): Date time that the contact record was last updated,\n     \"OrganisationId\" (string, required): id of the organisation linked to the contact,\n     \"IsActive\" (boolean, optional): Active indicator,\n     \"Industry\" (string, optional): Industry description,\n     \"FocusArea\" (string, optional): Focus area.\n     \"MicroSiteSubscriptions\": \n     [\n     {\n     \"SubscriberId\" (string, optional): Unique id of the microsite subscription,\n          \"MicroSite\": \n          {\n               \"Id\" (string, required): Unique id of the microsite,\n               \"Name\" (string, required): Name of the microsite \n          },\n          \"StartDate\" (string, optional): Date time that the subscription starts,\n          \"EndDate\" (string, optional): Date time that the subscription ends,\n          \"PolicyType\" (string, optional): The policy renewal status: 0 for new, 1 for renewal,\n     }\n     ]\n}\n

" 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: 561e208f8097920ed881e639 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: "

Model

\nContacts\n{\n     \"Id\" (string, required): Unique id of the contact,\n     \"EmailAddress\" (string, required): Email address of the contact,\n     \"FirstName\" (string, required): Given name of the contact,\n     \"JobTitle\" (string, optional): Job title of the contact,\n     \"LastName\" (string, required): Surname of the contact,\n     \"MobilePhoneNumber\" (string, optional): Mobile telephone number of the contact,\n     \"TelephoneNumber\" (string, optional): Groundline telephone number of the contact,\n     \"CreatedOn\" (string, required): Date time that the contact record was created,\n     \"UpdatedOn\" (string, required): Date time that the contact record was last updated,\n     \"OrganisationId\" (string, required): id of the organisation linked to the contact,\n     \"IsActive\" (boolean, optional): Active indicator,\n     \"Industry\" (string, optional): Industry description,\n     \"FocusArea\" (string, optional): Focus area.\n     \"MicroSiteSubscriptions\": \n     [\n     {\n     \"SubscriberId\" (string, optional): Unique id of the microsite subscription,\n          \"MicroSite\": \n          {\n               \"Id\" (string, required): Unique id of the microsite,\n               \"Name\" (string, required): Name of the microsite \n          },\n          \"StartDate\" (string, optional): Date time that the subscription starts,\n          \"EndDate\" (string, optional): Date time that the subscription ends,\n          \"PolicyType\" (string, optional): The policy renewal status: 0 for new, 1 for renewal,\n     }\n     ]\n}\n

" 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: 561e208f8097920ed881e63a 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: "

Model

\nContacts\n{\n     \"Id\" (string, required): Unique id of the contact,\n     \"EmailAddress\" (string, required): Email address of the contact,\n     \"FirstName\" (string, required): Given name of the contact,\n     \"JobTitle\" (string, optional): Job title of the contact,\n     \"LastName\" (string, required): Surname of the contact,\n     \"MobilePhoneNumber\" (string, optional): Mobile telephone number of the contact,\n     \"TelephoneNumber\" (string, optional): Groundline telephone number of the contact,\n     \"CreatedOn\" (string, required): Date time that the contact record was created,\n     \"UpdatedOn\" (string, required): Date time that the contact record was last updated,\n     \"OrganisationId\" (string, required): id of the organisation linked to the contact,\n     \"IsActive\" (boolean, optional): Active indicator,\n     \"Industry\" (string, optional): Industry description,\n     \"FocusArea\" (string, optional): Focus area,\n     \"MicroSiteSubscriptions\": \n     [\n     {\n     \"SubscriberId\" (string, optional): Unique id of the microsite subscription,\n          \"MicroSite\": \n          {\n               \"Id\" (string, required): Unique id of the microsite,\n               \"Name\" (string, required): Name of the microsite \n          },\n          \"StartDate\" (string, optional): Date time that the subscription starts,\n          \"EndDate\" (string, optional): Date time that the subscription ends,\n          \"PolicyType\" (string, optional): The policy renewal status: 0 for new, 1 for renewal,\n     }\n     ]\n}\n

" 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: 561e208f8097920ed881e63b 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: "

Model

\nContacts\n{\n     \"Id\" (string, required): Unique id of the contact,\n     \"EmailAddress\" (string, required): Email address of the contact,\n     \"FirstName\" (string, required): Given name of the contact,\n     \"JobTitle\" (string, optional): Job title of the contact,\n     \"LastName\" (string, required): Surname of the contact,\n     \"MobilePhoneNumber\" (string, optional): Mobile telephone number of the contact,\n     \"TelephoneNumber\" (string, optional): Groundline telephone number of the contact,\n     \"CreatedOn\" (string, required): Date time that the contact record was created,\n     \"UpdatedOn\" (string, required): Date time that the contact record was last updated,\n     \"OrganisationId\" (string, required): id of the organisation linked to the contact,\n     \"IsActive\" (boolean, optional): Active indicator,\n     \"Industry\" (string, optional): Industry description,\n     \"FocusArea\" (string, optional): Focus area,\n     \"MicroSiteSubscriptions\": \n     [\n     {\n     \"SubscriberId\" (string, optional): Unique id of the microsite subscription,\n          \"MicroSite\": \n          {\n               \"Id\" (string, required): Unique id of the microsite,\n               \"Name\" (string, required): Name of the microsite \n          },\n          \"StartDate\" (string, optional): Date time that the subscription starts,\n          \"EndDate\" (string, optional): Date time that the subscription ends,\n          \"PolicyType\" (string, optional): The policy renewal status: 0 for new, 1 for renewal,\n     }\n     ]\n}\n

" 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: 561e208f8097920ed881e63c 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: 561e208f8097920ed881e63d parameters: - name: id in: path description: '' required: true schema: type: string - name: ProviderID in: query description: '' required: true schema: type: string requestBody: description: "

Model

\nOrganisations\n{\n     \"Name\" (string, required): Name of the organisation,\n     \"NAICSCode\" (string, required): NAICS classification code of the organisation,\n     \"Address\"  (string, required): Primary address of the organisation,\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, optional): Organisation active indicator,\n}\n

" 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: 561e208f8097920ed881e63e parameters: - name: id in: path description: '' required: true schema: type: string - name: ProviderID in: query description: Your unique provider ID required: true schema: type: string responses: '200': description: "

Model

\nOrganisations\n{\n     \"Name\" (string, required): Name of the organisation,\n     \"NAICSCode\" (string, required): NAICS classification code of the organisation,\n     \"Address\"  (string, required): Primary address of the organisation,\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, optional): Organisation active indicator,\n}\n

" 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: 561e208f8097920ed881e63f 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: "

Model

\nOrganisations\n{\n     \"Name\" (string, required): Name of the organisation,\n     \"NAICSCode\" (string, required): NAICS classification code of the organisation,\n     \"Address\"  (string, required): Primary address of the organisation,\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, optional): Organisation active indicator,\n}\n

" 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: 561e208f8097920ed881e640 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: "

Model

\nOrganisations\n{\n     \"Name\" (string, required): Name of the organisation,\n     \"NAICSCode\" (string, required): NAICS classification code of the organisation,\n     \"Address\"  (string, required): Primary address of the organisation,\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, optional): Organisation active indicator,\n}\n

" 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: 561e208f8097920ed881e641 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: 57236b6697fe1e136834c547 parameters: - name: id in: path description: the key of the ‘parent’ organisation required: true schema: type: string requestBody: description: "

Model

\nOrganisations\n[\n  {\n     \"Name\" (string, required): Name of the organisation,\n     \"DoingBusinessAs\" (string, required): Trading name,\n     \"UniqueReference\" (string, required): Unique reference of the organisation,\n     \"StartDate\" (string, required): Policy start date,\n     \"ExpiryDate\" (string, required): Policy expiration date,\n     \"CancellationDate\" (string, optional): Policy cancellation date.\n }\n]\n

" content: application/json: example: - Name: A N Other Ltd DoingBusinessAs: A N Other Trading Ltd UniqueReference: GH/t336334 StartDate: '2016-01-01T00:00:00.0000000+00:00' ExpiryDate: '2016-12-31T00:00:00.0000000+00:00' CancellationDate: - Name: A and J Skips DoingBusinessAs: 'A and J Skips ' UniqueReference: '1000000082' StartDate: '2016-05-01T00:00:00.0000000+00:00' ExpiryDate: '2017-05-31T00:00:00.0000000+00:00' CancellationDate: responses: '200': description: '' components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]