openapi: 3.2.0 info: title: Beazley Contacts API version: '1.0' description: 'Operations tagged Contacts across 2 of this provider''s published API definitions: beazley-broker-and-insured-marketing-data-v2-sandbox.yml, beazley-broker-and-insured-marketing-data-v2.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.beazley.com/sandbox/marketing/v2 - url: https://api.beazley.com/marketing/v2 security: - apiKeyHeader: [] - apiKeyQuery: [] tags: - name: Contacts paths: /contacts/: post: summary: contact (POST) operationId: 561e208f8097920ed881e636 parameters: - name: ProviderID in: query required: true schema: type: string requestBody: description: "

Model

\n
\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 tags: - Contacts servers: - url: https://api.beazley.com/sandbox/marketing/v2 /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

\n
\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: '' tags: - Contacts servers: - url: https://api.beazley.com/sandbox/marketing/v2 /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

\n
\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 tags: - Contacts servers: - url: https://api.beazley.com/sandbox/marketing/v2 /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

\n
\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 tags: - Contacts servers: - url: https://api.beazley.com/sandbox/marketing/v2 components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query x-refined-from: - beazley-broker-and-insured-marketing-data-v2-sandbox.yml - beazley-broker-and-insured-marketing-data-v2.yml