Update the properties of a vendor.

External Documentation

To learn more, visit the AuditBoard documentation.

​
Basic Parameters

ParameterDescription
DescriptionA description of the vendor’s services, products, or purpose.
Effective dateThe date when the connection with the vendor became active.
NameA title or official name for the vendor organization.
NotesAdditional information or notes about the vendor.
StatusThe status of the vendor connection.
Vendor IDThe ID of the vendor to be updated.

​
Advanced Parameters

ParameterDescription
AddressThe street address of the vendor’s primary location.
CityThe city where the vendor is located.
Contact EmailThe email address of the vendor contact which must be unique across all vendor records.
Contact NameThe name of the primary vendor contact.
Contact Phone NumberThe phone number of the primary contact at the vendor organization.
Contract DetailsImportant details about the contract with the vendor.For example:Annual contract of $75,000 with auto-renewal clause.
CountryThe country where the vendor is located.
Formula DataDefine a calculation to automatically populate a field within the auditable entity. Use this to create dynamic, calculated values based on other fields.
Inherent RiskThe initial risk assessment associated with using this vendor.
Residual RiskThe remaining risk after applying controls and mitigation strategies.
StateThe state where the vendor is located.

​
Example Output

{
	"auditable_entities": [
		{
			"custom_date1": null,
			"custom_date2": null,
			"custom_date3": null,
			"custom_date4": null,
			"effective_date": null,
			"prior_audit_final_report_date": null,
			"risk_next_audit_due_date": null,
			"regulatory_next_audit_due_date": null,
			"id": 138,
			"uid": 138,
			"name": "test vendor",
			"auditable_entity_type_id": 18,
			"regulatory_audit_frequency_notes": "",
			"regulatory_next_audit_due": "",
			"risk_next_audit_due": "",
			"is_flagged": false,
			"custom_entity_reference": "",
			"description": "",
			"notes": "",
			"address": "",
			"city": "",
			"state": "",
			"country": "",
			"current_version": "",
			"contract_details": "",
			"contact_name": "",
			"contact_email": "",
			"contact_phone_number": "",
			"it_service_level_agreement": "",
			"it_recovery_time_objective": "",
			"it_recovery_point_objective": "",
			"custom_text1": "",
			"custom_text2": "",
			"custom_text3": "",
			"custom_text4": "",
			"custom_text5": "",
			"custom_text6": "",
			"custom_text7": "",
			"custom_text8": "",
			"custom_text9": "",
			"custom_text10": "",
			"custom_text11": "",
			"custom_text12": "",
			"custom_text13": "",
			"custom_text14": "",
			"custom_text15": "",
			"contact_user_id": 182,
			"created_by_user_id": 1,
			"formula_data": {},
			"residual_risk_calc": {},
			"field_data": {},
			"vendor_status": "requested",
			"_permissions": {
				"action.uploadFile": true,
				"action.delete": true,
				"action.viewFile": true,
				"action.deleteFile": true,
				"action.create": true,
				"action.edit": true,
				"action.view": true,
				"action.scheduleQuestionnaire": true,
				"action.deleteQuestionnaire": true,
				"action.sendQuestionnaire": true,
				"action.canCreateIssues": true,
				"action.manageContactUsers": true
			},
			"updated_at": "2023-01-24T20:23:07.641Z",
			"created_at": "2023-01-24T20:23:07.517Z",
			"deleted_at": null,
			"auditable_entity_region_id": null,
			"audit_rotation_schedule_id": null,
			"audit_office_location_id": null,
			"ae_custom_select1_option_id": null,
			"audit_division_id": null,
			"audit_business_segment_id": null,
			"ae_custom_select2_option_id": null,
			"assessment_id": null,
			"reviewer_user_id": null,
			"ae_custom_select3_option_id": null,
			"ae_custom_select4_option_id": null,
			"ae_custom_select5_option_id": null,
			"ae_custom_select6_option_id": null,
			"ae_custom_select7_option_id": null,
			"ae_custom_select8_option_id": null,
			"ae_status_option_id": null,
			"ae_custom_select9_option_id": null,
			"ae_custom_select10_option_id": null,
			"ae_custom_select11_option_id": null,
			"ae_custom_select12_option_id": null,
			"executive_user_id": null,
			"vice_president_user_id": null,
			"inherent_risk": null,
			"residual_risk": null,
			"manager_user_id": null,
			"coordinator_user_id": null,
			"product_status_id": null,
			"vendor_criticality_id": null,
			"legal_entity_type_id": null,
			"it_asset_type_id": null,
			"it_asset_status_id": null,
			"old_it_security_incident_hours": null,
			"employees_size": null,
			"regulatory_audit_frequency_id": null,
			"calculated_audit_frequency_id": null,
			"custom_decimal1": null,
			"custom_decimal2": null,
			"custom_decimal3": null,
			"custom_decimal4": null,
			"custom_decimal5": null,
			"custom_decimal6": null,
			"custom_decimal7": null,
			"custom_decimal8": null,
			"custom_currency1": null,
			"custom_currency2": null,
			"custom_currency3": null,
			"custom_currency4": null,
			"default_ops_audit_template_id": null,
			"risk_score_id": null,
			"prior_audit_id": null,
			"upcoming_audit_id": null,
			"it_security_incident_hours": null,
			"system_component_type_id": null,
			"sox_scope_id": null,
			"estimated_spend": null,
			"tprm_user_ids": [],
			"owner_user_ids": [
				1
			],
			"svp_owner_user_ids": [],
			"additional_owner_user_ids": [],
			"auditor_user_ids": [],
			"product_manager_user_ids": [],
			"allowed_team_ids": [],
			"admin_team_ids": []
		},
		{
			"custom_date1": null,
			"custom_date2": null,
			"custom_date3": null,
			"custom_date4": null,
			"effective_date": null,
			"prior_audit_final_report_date": null,
			"risk_next_audit_due_date": null,
			"regulatory_next_audit_due_date": null,
			"id": 138,
			"uid": "138",
			"name": "test vendor",
			"auditable_entity_type_id": 18,
			"regulatory_audit_frequency_notes": "",
			"regulatory_next_audit_due": "",
			"risk_next_audit_due": "",
			"regulatory_audit_frequency_id": null,
			"calculated_audit_frequency_id": null,
			"default_ops_audit_template_id": null,
			"prior_audit_id": null,
			"upcoming_audit_id": null,
			"is_flagged": false,
			"custom_entity_reference": "",
			"description": "",
			"notes": "",
			"address": "",
			"city": "",
			"state": "",
			"country": "",
			"current_version": "",
			"contract_details": "",
			"contact_name": "",
			"contact_email": "",
			"contact_phone_number": "",
			"estimated_spend": null,
			"it_service_level_agreement": "",
			"it_recovery_time_objective": "",
			"it_recovery_point_objective": "",
			"it_security_incident_hours": null,
			"employees_size": null,
			"custom_text1": "",
			"custom_text2": "",
			"custom_text3": "",
			"custom_text4": "",
			"custom_text5": "",
			"custom_text6": "",
			"custom_text7": "",
			"custom_text8": "",
			"custom_text9": "",
			"custom_text10": "",
			"custom_text11": "",
			"custom_text12": "",
			"custom_text13": "",
			"custom_text14": "",
			"custom_text15": "",
			"custom_decimal1": null,
			"custom_decimal2": null,
			"custom_decimal3": null,
			"custom_decimal4": null,
			"custom_decimal5": null,
			"custom_decimal6": null,
			"custom_decimal7": null,
			"custom_decimal8": null,
			"custom_currency1": null,
			"custom_currency2": null,
			"custom_currency3": null,
			"custom_currency4": null,
			"ae_status_option_id": null,
			"product_status_id": null,
			"vendor_criticality_id": null,
			"risk_score_id": null,
			"legal_entity_type_id": null,
			"system_component_type_id": null,
			"sox_scope_id": null,
			"it_asset_type_id": null,
			"it_asset_status_id": null,
			"auditable_entity_region_id": null,
			"audit_rotation_schedule_id": null,
			"audit_office_location_id": null,
			"audit_division_id": null,
			"audit_business_segment_id": null,
			"ae_custom_select1_option_id": null,
			"ae_custom_select2_option_id": null,
			"ae_custom_select3_option_id": null,
			"ae_custom_select4_option_id": null,
			"ae_custom_select5_option_id": null,
			"ae_custom_select6_option_id": null,
			"ae_custom_select7_option_id": null,
			"ae_custom_select8_option_id": null,
			"ae_custom_select9_option_id": null,
			"ae_custom_select10_option_id": null,
			"ae_custom_select11_option_id": null,
			"ae_custom_select12_option_id": null,
			"contact_user_id": 182,
			"reviewer_user_id": null,
			"executive_user_id": null,
			"vice_president_user_id": null,
			"manager_user_id": null,
			"coordinator_user_id": null,
			"created_by_user_id": 1,
			"formula_data": {},
			"residual_risk_calc": {},
			"inherent_risk": null,
			"residual_risk": null,
			"field_data": {},
			"vendor_status": "requested",
			"created_at": "2023-01-24T20:23:07.517Z",
			"updated_at": "2023-01-24T20:23:07.641Z",
			"deleted_at": null,
			"_permissions": {
				"action.uploadFile": true,
				"action.delete": true,
				"action.viewFile": true,
				"action.deleteFile": true,
				"action.create": true,
				"action.edit": true,
				"action.view": true,
				"action.scheduleQuestionnaire": true,
				"action.deleteQuestionnaire": true,
				"action.sendQuestionnaire": true,
				"action.canCreateIssues": true,
				"action.manageContactUsers": true
			},
			"tprm_user_ids": [
				1
			],
			"owner_user_ids": [
				1
			],
			"svp_owner_user_ids": [],
			"additional_owner_user_ids": [],
			"auditor_user_ids": [],
			"product_manager_user_ids": [],
			"allowed_team_ids": [],
			"admin_team_ids": []
		}
	],
	"auditable_entity_types": [
		{
			"id": 18,
			"name": "Vendor",
			"key": "vendor",
			"allowed_sections": [
				"compliance",
				"tprm"
			],
			"sort_order": 0,
			"form_template_id": 32,
			"intake_form_template_id": 13,
			"enabled_attributes": [
				"auditableEntity:name",
				"auditableEntity:description",
				"auditableEntity:auditableEntityRegion",
				"auditableEntity:address",
				"auditableEntity:city",
				"auditableEntity:state",
				"auditableEntity:country",
				"auditableEntity:controlsData",
				"auditableEntity:frameworkItems",
				"auditableEntity:frameworks",
				"auditableEntity:risks",
				"auditableEntity:inherentRisk",
				"auditableEntity:residualRisk",
				"auditableEntity:contractDetails",
				"auditableEntity:uid",
				"auditableEntity:auditableEntityType",
				"auditableEntity:vendorTypes",
				"auditableEntity:vendorCriticality",
				"auditableEntity:contactName",
				"auditableEntity:contactEmail",
				"auditableEntity:contactPhoneNumber",
				"auditableEntity:ownerUsers",
				"auditableEntity:additionalOwnerUsers",
				"auditableEntity:svpOwnerUsers",
				"auditableEntity:executiveUser",
				"auditableEntity:vicePresidentUser",
				"auditableEntity:itHostingModels",
				"auditableEntity:itHostingLocations",
				"auditableEntity:itServiceLevelAgreement",
				"auditableEntity:itRecoveryTimeObjective",
				"auditableEntity:itRecoveryPointObjective",
				"auditableEntity:itSecurityIncidentHours",
				"auditableEntity:employeesSize",
				"auditableEntity:businessActivities",
				"auditableEntity:businessFunctions",
				"auditableEntity:departments",
				"auditableEntity:auditableEntityReferences"
			],
			"excluded_attributes": [
				"auditableEntity:notes",
				"auditableEntity:customText1",
				"auditableEntity:customText2",
				"auditableEntity:customText3",
				"auditableEntity:customText4",
				"auditableEntity:customText5",
				"auditableEntity:customText6",
				"auditableEntity:customText7",
				"auditableEntity:customText8",
				"auditableEntity:customText9",
				"auditableEntity:customText10",
				"auditableEntity:customText11",
				"auditableEntity:customText12",
				"auditableEntity:customText13",
				"auditableEntity:customText14",
				"auditableEntity:customText15",
				"auditableEntity:auditorUsers",
				"auditableEntity:reviewerUser",
				"auditableEntity:managerUser",
				"auditableEntity:coordinatorUser",
				"auditableEntity:customDate1",
				"auditableEntity:customDate2",
				"auditableEntity:customDate3",
				"auditableEntity:customDate4",
				"auditableEntity:effectiveDate",
				"auditableEntity:aeStatusOption",
				"auditableEntity:aeCustomSelect1Option",
				"auditableEntity:aeCustomSelect2Option",
				"auditableEntity:aeCustomSelect3Option",
				"auditableEntity:aeCustomSelect4Option",
				"auditableEntity:aeCustomSelect5Option",
				"auditableEntity:aeCustomSelect6Option",
				"auditableEntity:aeCustomSelect7Option",
				"auditableEntity:aeCustomSelect8Option",
				"auditableEntity:aeCustomSelect9Option",
				"auditableEntity:aeCustomSelect10Option",
				"auditableEntity:aeCustomSelect11Option",
				"auditableEntity:aeCustomSelect12Option",
				"auditableEntity:customEntityReference",
				"auditableEntity:auditRotationSchedule",
				"auditableEntity:auditOfficeLocation",
				"auditableEntity:auditDivision",
				"auditableEntity:auditBusinessSegment",
				"auditableEntity:aeCustomMultiselect1Options",
				"auditableEntity:aeCustomMultiselect2Options",
				"auditableEntity:aeCustomMultiselect3Options",
				"auditableEntity:aeCustomMultiselect4Options",
				"auditableEntity:aeCustomMultiselect5Options",
				"auditableEntity:aeCustomMultiselect6Options"
			],
			"created_at": null,
			"updated_at": "2021-11-01T18:57:57.453Z",
			"deleted_at": null,
			"_permissions": {
				"action.administerAuditableEntities": true,
				"action.create": true,
				"action.delete": true,
				"action.edit": true,
				"action.manageAuditableEntities": true,
				"action.submitAuditableEntities": true,
				"action.view": true,
				"action.viewAuditableEntities": true
			},
			"owner_user_ids": [],
			"allowed_team_ids": [],
			"admin_team_ids": [],
			"manager_team_ids": [],
			"viewonly_team_ids": [],
			"createonly_team_ids": []
		}
	],
	"users": [
		{
			"avatar_signed_url": "",
			"api_user_last_login": null,
			"has_external_api_token": false,
			"full_name": "John Smith",
			"initials": "RR",
			"id": 182,
			"role_id": 11,
			"core_modules": [],
			"first_name": "John",
			"last_name": "Smith",
			"avatar_key": "",
			"username": "JohnSmith",
			"job_title": "",
			"employee_number": "",
			"competency_evaluation": "",
			"login_attempt": 0,
			"email": "rjohnston@auditboard.com",
			"accepted_terms": false,
			"requires_password_change": false,
			"icon_bg_color": "#e1563f",
			"icon_fg_color": "#ffffff",
			"auth_type": "password",
			"sent_slack_welcome_notification": false,
			"teams_notifications_enabled": false,
			"cell_phone": "",
			"mfa_enabled": false,
			"chameleon_identifier": "",
			"scim_user_active": "true",
			"locale": "",
			"updated_at": "2023-01-24T20:23:07.425Z",
			"created_at": "2023-01-24T20:23:07.425Z",
			"deleted_at": null,
			"password_history": null,
			"user_stat_id": null,
			"location_id": null,
			"department_id": null,
			"last_login_failed_attempt": null,
			"slack_user_id": null,
			"azure_conversation_data": null,
			"_permissions": {
				"action.administer": true,
				"action.edit": true,
				"action.view": true
			}
		}
	],
	"tprm_users": [
		{
			"id": 1,
			"email": "rjohnston@auditboard.com",
			"first_name": "John",
			"last_name": "Smith",
			"status": "Active",
			"role": "Primary",
			"user_id": 182,
			"auditable_entity_id": 138,
			"_permissions": {
				"action.approveTprmUser": true,
				"action.create": true,
				"action.denyTprmUser": true,
				"action.edit": true,
				"action.view": true
			},
			"updated_at": "2023-01-24T20:23:07.703Z",
			"created_at": "2023-01-24T20:23:07.703Z",
			"deleted_at": null,
			"invited_questionnaires": null
		}
	]
}

​
Workflow Library Example

Update Vendor with Auditboard and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?