Update workspace integration
PUT/unified/workspaceintegration/{id}
Parameters
idstring required
ID of the Workspaceintegration
Payload
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring
(reference to KmsSpace)
integration_typestring required
is_activeboolean required
api_urlstring
authorize_urlstring
token_urlstring
refresh_urlstring
base_urlstring
prompt_regionboolean
use_unified_redirectboolean
auth_type enum
Valid values:
"oauth2"
"other"
"token"
the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)
environmentstring
authentication environment
categories enum array
derived from
permissions (plus the auth, passthrough and saml categories, which have no permissions)permissions enum array
Valid values:
the unified permission scopes enabled for this integration; requested when an authorization URL omits
scopessuccess_redirectstring
Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by
/oauth/code/{workspace}/{env}/{integration}.failure_redirectstring
Post-OAuth failure URL for marketplace installs. Used by
/oauth/code/{workspace}/{env}/{integration}.secretsmanager_idstring
the ID of the SecretsManager object
secretsmanager_keystring
the key/path/name of the secret within the vault
Returns
| Response field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
workspace_id | string | No | (reference to KmsSpace) |
integration_type | string | Yes | |
is_active | boolean | Yes | |
api_url | string | No | |
authorize_url | string | No | |
token_url | string | No | |
refresh_url | string | No | |
base_url | string | No | |
prompt_region | boolean | No | |
use_unified_redirect | boolean | No | |
auth_type | enum | No | the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist) Values: oauth2, other, token |
environment | string | No | authentication environment |
categories | enum | No | derived from permissions (plus the auth, passthrough and saml categories, which have no permissions) Values: passthrough, hris, ats, auth, saml, crm, enrich, martech, ticketing, uc, accounting, storage, commerce, payment, genai, messaging, kms, task, scim, lms, repo, metadata, calendar, verification, ads, analytics, forms, shipping, assessment, signing, clubs, datastore, cdp, performance, social, legal, compute, healthcare, property, plm |
permissions | enum | No | the unified permission scopes enabled for this integration; requested when an authorization URL omits scopes Values: accounting_account_read, accounting_account_write, accounting_transaction_read, accounting_transaction_write, accounting_journal_read, accounting_journal_write, accounting_invoice_read, accounting_invoice_write, accounting_bill_read, accounting_bill_write, accounting_vendorcredit_read, accounting_vendorcredit_write, accounting_creditmemo_read, accounting_creditmemo_write, accounting_contact_read, accounting_contact_write, accounting_expense_read, accounting_expense_write, accounting_expensereport_read, accounting_expensereport_write, accounting_purchasereceipt_read, accounting_purchasereceipt_write, accounting_taxrate_read, accounting_taxrate_write, accounting_paymentterm_read, accounting_paymentterm_write, accounting_organization_read, accounting_order_read, accounting_order_write, accounting_purchaseorder_read, accounting_purchaseorder_write, accounting_salesorder_read, accounting_salesorder_write, accounting_salesreceipt_read, accounting_salesreceipt_write, accounting_trialbalance_read, accounting_trialbalance_write, accounting_profitloss_read, accounting_profitloss_write, accounting_balancesheet_read, accounting_balancesheet_write, accounting_category_read, accounting_category_write, payment_payment_read, payment_payment_write, accounting_cashflow_read, accounting_cashflow_write, accounting_quote_read, accounting_quote_write, accounting_agedreceivable_read, accounting_agedpayable_read, accounting_project_read, accounting_project_write, accounting_bankfeedaccount_read, accounting_bankfeedaccount_write, accounting_bankfeedtransaction_read, accounting_bankfeedtransaction_write, payment_payout_read, payment_refund_read, payment_link_read, payment_link_write, payment_subscription_read, payment_subscription_write, commerce_item_read, commerce_item_write, commerce_collection_read, commerce_collection_write, commerce_inventory_read, commerce_inventory_write, commerce_location_read, commerce_location_write, commerce_review_read, commerce_review_write, commerce_saleschannel_read, commerce_saleschannel_write, commerce_itemvariant_read, commerce_itemvariant_write, commerce_reservation_read, commerce_reservation_write, commerce_table_read, commerce_table_write, commerce_return_read, commerce_return_write, commerce_availability_read, commerce_availability_write, verification_package_read, verification_request_read, verification_request_write, assessment_package_read, assessment_package_write, assessment_order_write, ats_activity_read, ats_activity_write, ats_application_read, ats_application_write, ats_applicationstatus_read, ats_candidate_read, ats_candidate_write, ats_interview_read, ats_interview_write, ats_job_read, ats_job_write, ats_company_read, ats_company_write, ats_document_read, ats_document_write, ats_scorecard_read, ats_scorecard_write, crm_company_read, crm_company_write, crm_contact_read, crm_contact_write, crm_deal_read, crm_deal_write, crm_event_read, crm_event_write, crm_lead_read, crm_lead_write, crm_pipeline_read, crm_pipeline_write, crm_taxonomy_read, martech_list_read, martech_list_write, martech_member_read, martech_member_write, martech_campaign_read, martech_campaign_write, martech_report_read, martech_report_write, ticketing_customer_read, ticketing_customer_write, ticketing_ticket_read, ticketing_ticket_write, ticketing_note_read, ticketing_note_write, ticketing_category_read, ticketing_category_write, hris_employee_read, hris_employee_write, hris_group_read, hris_group_write, hris_payslip_read, hris_payslip_write, hris_timeoff_read, hris_timeoff_write, hris_timeshift_read, hris_timeshift_write, hris_attendance_read, hris_attendance_write, hris_company_read, hris_company_write, hris_location_read, hris_location_write, hris_device_read, hris_device_write, hris_deduction_read, hris_deduction_write, hris_benefit_read, hris_benefit_write, hris_bankaccount_read, hris_bankaccount_write, hris_document_read, hris_document_write, hris_taxonomy_read, hris_taxonomy_write, hris_job_read, hris_job_write, hris_payroll_read, hris_payroll_write, hris_paycode_read, hris_paycode_write, hris_earning_read, hris_earning_write, uc_call_read, uc_call_write, uc_contact_read, uc_contact_write, uc_fax_read, uc_fax_write, uc_comment_read, uc_comment_write, uc_recording_read, uc_scorecard_read, uc_scorecardtemplate_read, storage_file_read, storage_file_write, webhook, genai_model_read, genai_prompt_read, genai_prompt_write, genai_embedding_read, genai_embedding_write, genai_task_read, genai_task_write, genai_agent_read, genai_agent_write, genai_organization_read, genai_organization_write, genai_skill_read, genai_skill_write, genai_memory_read, genai_memory_write, messaging_message_read, messaging_message_write, messaging_channel_read, messaging_channel_write, messaging_event_read, messaging_event_write, kms_space_read, kms_space_write, kms_page_read, kms_page_write, kms_comment_read, kms_comment_write, task_project_read, task_project_write, task_task_read, task_task_write, task_change_read, task_comment_read, task_comment_write, scim_users_read, scim_users_write, scim_groups_read, scim_groups_write, lms_course_read, lms_course_write, lms_class_read, lms_class_write, lms_student_read, lms_student_write, lms_instructor_read, lms_instructor_write, lms_content_read, lms_content_write, lms_collection_read, lms_collection_write, lms_activity_read, lms_activity_write, repo_organization_read, repo_organization_write, repo_repository_read, repo_repository_write, repo_branch_read, repo_branch_write, repo_commit_read, repo_commit_write, repo_pullrequest_read, repo_pullrequest_write, metadata_metadata_read, metadata_metadata_write, calendar_calendar_read, calendar_calendar_write, calendar_event_read, calendar_event_write, calendar_busy_read, calendar_link_read, calendar_link_write, calendar_recording_read, calendar_recording_write, calendar_webinar_read, calendar_webinar_write, calendar_bot_read, calendar_bot_write, calendar_botevent_read, calendar_room_read, calendar_location_read, enrich_person_read, enrich_company_read, ads_ad_read, ads_ad_write, ads_campaign_read, ads_campaign_write, ads_group_read, ads_group_write, ads_report_read, ads_organization_read, ads_organization_write, ads_creative_read, ads_creative_write, ads_asset_read, ads_asset_write, ads_insertionorder_read, ads_insertionorder_write, ads_target_read, ads_promoted_read, analytics_property_read, analytics_property_write, analytics_event_read, analytics_event_write, analytics_session_read, analytics_visitor_read, analytics_visitor_write, analytics_report_read, forms_form_read, forms_form_write, forms_submission_read, forms_submission_write, shipping_shipment_read, shipping_shipment_write, shipping_label_read, shipping_label_write, shipping_tracking_read, shipping_rate_read, shipping_rate_write, shipping_carrier_read, signing_document_read, signing_document_write, signing_signatory_read, signing_signatory_write, signing_template_read, signing_template_write, clubs_group_read, clubs_group_write, clubs_member_read, clubs_member_write, clubs_activity_read, clubs_activity_write, clubs_location_read, clubs_location_write, clubs_event_read, clubs_event_write, datastore_database_read, datastore_database_write, datastore_table_read, datastore_table_write, datastore_record_read, datastore_record_write, datastore_query_read, datastore_query_write, cdp_profile_read, cdp_profile_write, cdp_segment_read, cdp_segment_write, cdp_event_read, cdp_event_write, cdp_source_read, cdp_source_write, cdp_destination_read, cdp_destination_write, cdp_activation_read, cdp_activation_write, performance_cycle_read, performance_review_read, performance_review_write, performance_goal_read, performance_goal_write, performance_feedback_read, performance_feedback_write, social_post_read, social_post_write, social_profile_read, social_profile_write, social_review_read, social_review_write, social_insight_read, social_insight_write, legal_matter_read, legal_matter_write, legal_practicearea_read, legal_practicearea_write, legal_timeentry_read, legal_timeentry_write, legal_expense_read, legal_expense_write, compute_instance_read, compute_instance_write, compute_template_read, compute_template_write, compute_gputype_read, compute_region_read, compute_volume_read, compute_volume_write, compute_snapshot_read, compute_snapshot_write, compute_usage_read, compute_key_read, compute_key_write, compute_service_read, compute_service_write, compute_deployment_read, compute_deployment_write, compute_domain_read, compute_domain_write, compute_envvar_read, compute_envvar_write, healthcare_patient_read, healthcare_patient_write, healthcare_practitioner_read, healthcare_practitioner_write, healthcare_location_read, healthcare_location_write, healthcare_appointment_read, healthcare_appointment_write, healthcare_slot_read, healthcare_slot_write, healthcare_encounter_read, healthcare_encounter_write, healthcare_condition_read, healthcare_condition_write, healthcare_allergy_read, healthcare_allergy_write, healthcare_medication_read, healthcare_medication_write, healthcare_observation_read, healthcare_observation_write, healthcare_immunization_read, healthcare_immunization_write, healthcare_document_read, healthcare_document_write, healthcare_coverage_read, healthcare_coverage_write, healthcare_procedure_read, healthcare_procedure_write, healthcare_report_read, healthcare_report_write, healthcare_careplan_read, healthcare_careplan_write, healthcare_goal_read, healthcare_goal_write, property_listing_read, property_listing_write, property_unittype_read, property_guest_read, property_guest_write, property_reservation_read, property_reservation_write, property_availability_read, property_quote_read, property_quote_write, property_review_read, property_review_write, property_conversation_read, property_conversation_write, plm_part_read, plm_part_write, plm_bomline_read, plm_bomline_write, plm_document_read, plm_document_write, plm_change_read, plm_change_write, plm_category_read, plm_category_write |
overriden_scopes | object | No | |
overriden_scopes.accounting_account_read | string | No | |
overriden_scopes.accounting_account_write | string | No | |
overriden_scopes.accounting_transaction_read | string | No | |
overriden_scopes.accounting_transaction_write | string | No | |
overriden_scopes.accounting_journal_read | string | No | |
overriden_scopes.accounting_journal_write | string | No | |
overriden_scopes.accounting_invoice_read | string | No | |
overriden_scopes.accounting_invoice_write | string | No | |
overriden_scopes.accounting_bill_read | string | No | |
overriden_scopes.accounting_bill_write | string | No | |
overriden_scopes.accounting_vendorcredit_read | string | No | |
overriden_scopes.accounting_vendorcredit_write | string | No | |
overriden_scopes.accounting_creditmemo_read | string | No | |
overriden_scopes.accounting_creditmemo_write | string | No | |
overriden_scopes.accounting_contact_read | string | No | |
overriden_scopes.accounting_contact_write | string | No | |
overriden_scopes.accounting_expense_read | string | No | |
overriden_scopes.accounting_expense_write | string | No | |
overriden_scopes.accounting_expensereport_read | string | No | |
overriden_scopes.accounting_expensereport_write | string | No | |
overriden_scopes.accounting_purchasereceipt_read | string | No | |
overriden_scopes.accounting_purchasereceipt_write | string | No | |
overriden_scopes.accounting_taxrate_read | string | No | |
overriden_scopes.accounting_taxrate_write | string | No | |
overriden_scopes.accounting_paymentterm_read | string | No | |
overriden_scopes.accounting_paymentterm_write | string | No | |
overriden_scopes.accounting_organization_read | string | No | |
overriden_scopes.accounting_order_read | string | No | |
overriden_scopes.accounting_order_write | string | No | |
overriden_scopes.accounting_purchaseorder_read | string | No | |
overriden_scopes.accounting_purchaseorder_write | string | No | |
overriden_scopes.accounting_salesorder_read | string | No | |
overriden_scopes.accounting_salesorder_write | string | No | |
overriden_scopes.accounting_salesreceipt_read | string | No | |
overriden_scopes.accounting_salesreceipt_write | string | No | |
overriden_scopes.accounting_trialbalance_read | string | No | |
overriden_scopes.accounting_trialbalance_write | string | No | |
overriden_scopes.accounting_profitloss_read | string | No | |
overriden_scopes.accounting_profitloss_write | string | No | |
overriden_scopes.accounting_balancesheet_read | string | No | |
overriden_scopes.accounting_balancesheet_write | string | No | |
overriden_scopes.accounting_category_read | string | No | |
overriden_scopes.accounting_category_write | string | No | |
overriden_scopes.payment_payment_read | string | No | |
overriden_scopes.payment_payment_write | string | No | |
overriden_scopes.accounting_cashflow_read | string | No | |
overriden_scopes.accounting_cashflow_write | string | No | |
overriden_scopes.accounting_quote_read | string | No | |
overriden_scopes.accounting_quote_write | string | No | |
overriden_scopes.accounting_agedreceivable_read | string | No | |
overriden_scopes.accounting_agedpayable_read | string | No | |
overriden_scopes.accounting_project_read | string | No | |
overriden_scopes.accounting_project_write | string | No | |
overriden_scopes.accounting_bankfeedaccount_read | string | No | |
overriden_scopes.accounting_bankfeedaccount_write | string | No | |
overriden_scopes.accounting_bankfeedtransaction_read | string | No | |
overriden_scopes.accounting_bankfeedtransaction_write | string | No | |
overriden_scopes.payment_payout_read | string | No | |
overriden_scopes.payment_refund_read | string | No | |
overriden_scopes.payment_link_read | string | No | |
overriden_scopes.payment_link_write | string | No | |
overriden_scopes.payment_subscription_read | string | No | |
overriden_scopes.payment_subscription_write | string | No | |
overriden_scopes.commerce_item_read | string | No | |
overriden_scopes.commerce_item_write | string | No | |
overriden_scopes.commerce_collection_read | string | No | |
overriden_scopes.commerce_collection_write | string | No | |
overriden_scopes.commerce_inventory_read | string | No | |
overriden_scopes.commerce_inventory_write | string | No | |
overriden_scopes.commerce_location_read | string | No | |
overriden_scopes.commerce_location_write | string | No | |
overriden_scopes.commerce_review_read | string | No | |
overriden_scopes.commerce_review_write | string | No | |
overriden_scopes.commerce_saleschannel_read | string | No | |
overriden_scopes.commerce_saleschannel_write | string | No | |
overriden_scopes.commerce_itemvariant_read | string | No | |
overriden_scopes.commerce_itemvariant_write | string | No | |
overriden_scopes.commerce_reservation_read | string | No | |
overriden_scopes.commerce_reservation_write | string | No | |
overriden_scopes.commerce_table_read | string | No | |
overriden_scopes.commerce_table_write | string | No | |
overriden_scopes.commerce_return_read | string | No | |
overriden_scopes.commerce_return_write | string | No | |
overriden_scopes.commerce_availability_read | string | No | |
overriden_scopes.commerce_availability_write | string | No | |
overriden_scopes.verification_package_read | string | No | |
overriden_scopes.verification_request_read | string | No | |
overriden_scopes.verification_request_write | string | No | |
overriden_scopes.assessment_package_read | string | No | |
overriden_scopes.assessment_package_write | string | No | |
overriden_scopes.assessment_order_write | string | No | |
overriden_scopes.ats_activity_read | string | No | |
overriden_scopes.ats_activity_write | string | No | |
overriden_scopes.ats_application_read | string | No | |
overriden_scopes.ats_application_write | string | No | |
overriden_scopes.ats_applicationstatus_read | string | No | |
overriden_scopes.ats_candidate_read | string | No | |
overriden_scopes.ats_candidate_write | string | No | |
overriden_scopes.ats_interview_read | string | No | |
overriden_scopes.ats_interview_write | string | No | |
overriden_scopes.ats_job_read | string | No | |
overriden_scopes.ats_job_write | string | No | |
overriden_scopes.ats_company_read | string | No | |
overriden_scopes.ats_company_write | string | No | |
overriden_scopes.ats_document_read | string | No | |
overriden_scopes.ats_document_write | string | No | |
overriden_scopes.ats_scorecard_read | string | No | |
overriden_scopes.ats_scorecard_write | string | No | |
overriden_scopes.crm_company_read | string | No | |
overriden_scopes.crm_company_write | string | No | |
overriden_scopes.crm_contact_read | string | No | |
overriden_scopes.crm_contact_write | string | No | |
overriden_scopes.crm_deal_read | string | No | |
overriden_scopes.crm_deal_write | string | No | |
overriden_scopes.crm_event_read | string | No | |
overriden_scopes.crm_event_write | string | No | |
overriden_scopes.crm_lead_read | string | No | |
overriden_scopes.crm_lead_write | string | No | |
overriden_scopes.crm_pipeline_read | string | No | |
overriden_scopes.crm_pipeline_write | string | No | |
overriden_scopes.crm_taxonomy_read | string | No | |
overriden_scopes.martech_list_read | string | No | |
overriden_scopes.martech_list_write | string | No | |
overriden_scopes.martech_member_read | string | No | |
overriden_scopes.martech_member_write | string | No | |
overriden_scopes.martech_campaign_read | string | No | |
overriden_scopes.martech_campaign_write | string | No | |
overriden_scopes.martech_report_read | string | No | |
overriden_scopes.martech_report_write | string | No | |
overriden_scopes.ticketing_customer_read | string | No | |
overriden_scopes.ticketing_customer_write | string | No | |
overriden_scopes.ticketing_ticket_read | string | No | |
overriden_scopes.ticketing_ticket_write | string | No | |
overriden_scopes.ticketing_note_read | string | No | |
overriden_scopes.ticketing_note_write | string | No | |
overriden_scopes.ticketing_category_read | string | No | |
overriden_scopes.ticketing_category_write | string | No | |
overriden_scopes.hris_employee_read | string | No | |
overriden_scopes.hris_employee_write | string | No | |
overriden_scopes.hris_group_read | string | No | |
overriden_scopes.hris_group_write | string | No | |
overriden_scopes.hris_payslip_read | string | No | |
overriden_scopes.hris_payslip_write | string | No | |
overriden_scopes.hris_timeoff_read | string | No | |
overriden_scopes.hris_timeoff_write | string | No | |
overriden_scopes.hris_timeshift_read | string | No | |
overriden_scopes.hris_timeshift_write | string | No | |
overriden_scopes.hris_attendance_read | string | No | |
overriden_scopes.hris_attendance_write | string | No | |
overriden_scopes.hris_company_read | string | No | |
overriden_scopes.hris_company_write | string | No | |
overriden_scopes.hris_location_read | string | No | |
overriden_scopes.hris_location_write | string | No | |
overriden_scopes.hris_device_read | string | No | |
overriden_scopes.hris_device_write | string | No | |
overriden_scopes.hris_deduction_read | string | No | |
overriden_scopes.hris_deduction_write | string | No | |
overriden_scopes.hris_benefit_read | string | No | |
overriden_scopes.hris_benefit_write | string | No | |
overriden_scopes.hris_bankaccount_read | string | No | |
overriden_scopes.hris_bankaccount_write | string | No | |
overriden_scopes.hris_document_read | string | No | |
overriden_scopes.hris_document_write | string | No | |
overriden_scopes.hris_taxonomy_read | string | No | |
overriden_scopes.hris_taxonomy_write | string | No | |
overriden_scopes.hris_job_read | string | No | |
overriden_scopes.hris_job_write | string | No | |
overriden_scopes.hris_payroll_read | string | No | |
overriden_scopes.hris_payroll_write | string | No | |
overriden_scopes.hris_paycode_read | string | No | |
overriden_scopes.hris_paycode_write | string | No | |
overriden_scopes.hris_earning_read | string | No | |
overriden_scopes.hris_earning_write | string | No | |
overriden_scopes.uc_call_read | string | No | |
overriden_scopes.uc_call_write | string | No | |
overriden_scopes.uc_contact_read | string | No | |
overriden_scopes.uc_contact_write | string | No | |
overriden_scopes.uc_fax_read | string | No | |
overriden_scopes.uc_fax_write | string | No | |
overriden_scopes.uc_comment_read | string | No | |
overriden_scopes.uc_comment_write | string | No | |
overriden_scopes.uc_recording_read | string | No | |
overriden_scopes.uc_scorecard_read | string | No | |
overriden_scopes.uc_scorecardtemplate_read | string | No | |
overriden_scopes.storage_file_read | string | No | |
overriden_scopes.storage_file_write | string | No | |
overriden_scopes.webhook | string | No | |
overriden_scopes.genai_model_read | string | No | |
overriden_scopes.genai_prompt_read | string | No | |
overriden_scopes.genai_prompt_write | string | No | |
overriden_scopes.genai_embedding_read | string | No | |
overriden_scopes.genai_embedding_write | string | No | |
overriden_scopes.genai_task_read | string | No | |
overriden_scopes.genai_task_write | string | No | |
overriden_scopes.genai_agent_read | string | No | |
overriden_scopes.genai_agent_write | string | No | |
overriden_scopes.genai_organization_read | string | No | |
overriden_scopes.genai_organization_write | string | No | |
overriden_scopes.genai_skill_read | string | No | |
overriden_scopes.genai_skill_write | string | No | |
overriden_scopes.genai_memory_read | string | No | |
overriden_scopes.genai_memory_write | string | No | |
overriden_scopes.messaging_message_read | string | No | |
overriden_scopes.messaging_message_write | string | No | |
overriden_scopes.messaging_channel_read | string | No | |
overriden_scopes.messaging_channel_write | string | No | |
overriden_scopes.messaging_event_read | string | No | |
overriden_scopes.messaging_event_write | string | No | |
overriden_scopes.kms_space_read | string | No | |
overriden_scopes.kms_space_write | string | No | |
overriden_scopes.kms_page_read | string | No | |
overriden_scopes.kms_page_write | string | No | |
overriden_scopes.kms_comment_read | string | No | |
overriden_scopes.kms_comment_write | string | No | |
overriden_scopes.task_project_read | string | No | |
overriden_scopes.task_project_write | string | No | |
overriden_scopes.task_task_read | string | No | |
overriden_scopes.task_task_write | string | No | |
overriden_scopes.task_change_read | string | No | |
overriden_scopes.task_comment_read | string | No | |
overriden_scopes.task_comment_write | string | No | |
overriden_scopes.scim_users_read | string | No | |
overriden_scopes.scim_users_write | string | No | |
overriden_scopes.scim_groups_read | string | No | |
overriden_scopes.scim_groups_write | string | No | |
overriden_scopes.lms_course_read | string | No | |
overriden_scopes.lms_course_write | string | No | |
overriden_scopes.lms_class_read | string | No | |
overriden_scopes.lms_class_write | string | No | |
overriden_scopes.lms_student_read | string | No | |
overriden_scopes.lms_student_write | string | No | |
overriden_scopes.lms_instructor_read | string | No | |
overriden_scopes.lms_instructor_write | string | No | |
overriden_scopes.lms_content_read | string | No | |
overriden_scopes.lms_content_write | string | No | |
overriden_scopes.lms_collection_read | string | No | |
overriden_scopes.lms_collection_write | string | No | |
overriden_scopes.lms_activity_read | string | No | |
overriden_scopes.lms_activity_write | string | No | |
overriden_scopes.repo_organization_read | string | No | |
overriden_scopes.repo_organization_write | string | No | |
overriden_scopes.repo_repository_read | string | No | |
overriden_scopes.repo_repository_write | string | No | |
overriden_scopes.repo_branch_read | string | No | |
overriden_scopes.repo_branch_write | string | No | |
overriden_scopes.repo_commit_read | string | No | |
overriden_scopes.repo_commit_write | string | No | |
overriden_scopes.repo_pullrequest_read | string | No | |
overriden_scopes.repo_pullrequest_write | string | No | |
overriden_scopes.metadata_metadata_read | string | No | |
overriden_scopes.metadata_metadata_write | string | No | |
overriden_scopes.calendar_calendar_read | string | No | |
overriden_scopes.calendar_calendar_write | string | No | |
overriden_scopes.calendar_event_read | string | No | |
overriden_scopes.calendar_event_write | string | No | |
overriden_scopes.calendar_busy_read | string | No | |
overriden_scopes.calendar_link_read | string | No | |
overriden_scopes.calendar_link_write | string | No | |
overriden_scopes.calendar_recording_read | string | No | |
overriden_scopes.calendar_recording_write | string | No | |
overriden_scopes.calendar_webinar_read | string | No | |
overriden_scopes.calendar_webinar_write | string | No | |
overriden_scopes.calendar_bot_read | string | No | |
overriden_scopes.calendar_bot_write | string | No | |
overriden_scopes.calendar_botevent_read | string | No | |
overriden_scopes.calendar_room_read | string | No | |
overriden_scopes.calendar_location_read | string | No | |
overriden_scopes.enrich_person_read | string | No | |
overriden_scopes.enrich_company_read | string | No | |
overriden_scopes.ads_ad_read | string | No | |
overriden_scopes.ads_ad_write | string | No | |
overriden_scopes.ads_campaign_read | string | No | |
overriden_scopes.ads_campaign_write | string | No | |
overriden_scopes.ads_group_read | string | No | |
overriden_scopes.ads_group_write | string | No | |
overriden_scopes.ads_report_read | string | No | |
overriden_scopes.ads_organization_read | string | No | |
overriden_scopes.ads_organization_write | string | No | |
overriden_scopes.ads_creative_read | string | No | |
overriden_scopes.ads_creative_write | string | No | |
overriden_scopes.ads_asset_read | string | No | |
overriden_scopes.ads_asset_write | string | No | |
overriden_scopes.ads_insertionorder_read | string | No | |
overriden_scopes.ads_insertionorder_write | string | No | |
overriden_scopes.ads_target_read | string | No | |
overriden_scopes.ads_promoted_read | string | No | |
overriden_scopes.analytics_property_read | string | No | |
overriden_scopes.analytics_property_write | string | No | |
overriden_scopes.analytics_event_read | string | No | |
overriden_scopes.analytics_event_write | string | No | |
overriden_scopes.analytics_session_read | string | No | |
overriden_scopes.analytics_visitor_read | string | No | |
overriden_scopes.analytics_visitor_write | string | No | |
overriden_scopes.analytics_report_read | string | No | |
overriden_scopes.forms_form_read | string | No | |
overriden_scopes.forms_form_write | string | No | |
overriden_scopes.forms_submission_read | string | No | |
overriden_scopes.forms_submission_write | string | No | |
overriden_scopes.shipping_shipment_read | string | No | |
overriden_scopes.shipping_shipment_write | string | No | |
overriden_scopes.shipping_label_read | string | No | |
overriden_scopes.shipping_label_write | string | No | |
overriden_scopes.shipping_tracking_read | string | No | |
overriden_scopes.shipping_rate_read | string | No | |
overriden_scopes.shipping_rate_write | string | No | |
overriden_scopes.shipping_carrier_read | string | No | |
overriden_scopes.signing_document_read | string | No | |
overriden_scopes.signing_document_write | string | No | |
overriden_scopes.signing_signatory_read | string | No | |
overriden_scopes.signing_signatory_write | string | No | |
overriden_scopes.signing_template_read | string | No | |
overriden_scopes.signing_template_write | string | No | |
overriden_scopes.clubs_group_read | string | No | |
overriden_scopes.clubs_group_write | string | No | |
overriden_scopes.clubs_member_read | string | No | |
overriden_scopes.clubs_member_write | string | No | |
overriden_scopes.clubs_activity_read | string | No | |
overriden_scopes.clubs_activity_write | string | No | |
overriden_scopes.clubs_location_read | string | No | |
overriden_scopes.clubs_location_write | string | No | |
overriden_scopes.clubs_event_read | string | No | |
overriden_scopes.clubs_event_write | string | No | |
overriden_scopes.datastore_database_read | string | No | |
overriden_scopes.datastore_database_write | string | No | |
overriden_scopes.datastore_table_read | string | No | |
overriden_scopes.datastore_table_write | string | No | |
overriden_scopes.datastore_record_read | string | No | |
overriden_scopes.datastore_record_write | string | No | |
overriden_scopes.datastore_query_read | string | No | |
overriden_scopes.datastore_query_write | string | No | |
overriden_scopes.cdp_profile_read | string | No | |
overriden_scopes.cdp_profile_write | string | No | |
overriden_scopes.cdp_segment_read | string | No | |
overriden_scopes.cdp_segment_write | string | No | |
overriden_scopes.cdp_event_read | string | No | |
overriden_scopes.cdp_event_write | string | No | |
overriden_scopes.cdp_source_read | string | No | |
overriden_scopes.cdp_source_write | string | No | |
overriden_scopes.cdp_destination_read | string | No | |
overriden_scopes.cdp_destination_write | string | No | |
overriden_scopes.cdp_activation_read | string | No | |
overriden_scopes.cdp_activation_write | string | No | |
overriden_scopes.performance_cycle_read | string | No | |
overriden_scopes.performance_review_read | string | No | |
overriden_scopes.performance_review_write | string | No | |
overriden_scopes.performance_goal_read | string | No | |
overriden_scopes.performance_goal_write | string | No | |
overriden_scopes.performance_feedback_read | string | No | |
overriden_scopes.performance_feedback_write | string | No | |
overriden_scopes.social_post_read | string | No | |
overriden_scopes.social_post_write | string | No | |
overriden_scopes.social_profile_read | string | No | |
overriden_scopes.social_profile_write | string | No | |
overriden_scopes.social_review_read | string | No | |
overriden_scopes.social_review_write | string | No | |
overriden_scopes.social_insight_read | string | No | |
overriden_scopes.social_insight_write | string | No | |
overriden_scopes.legal_matter_read | string | No | |
overriden_scopes.legal_matter_write | string | No | |
overriden_scopes.legal_practicearea_read | string | No | |
overriden_scopes.legal_practicearea_write | string | No | |
overriden_scopes.legal_timeentry_read | string | No | |
overriden_scopes.legal_timeentry_write | string | No | |
overriden_scopes.legal_expense_read | string | No | |
overriden_scopes.legal_expense_write | string | No | |
overriden_scopes.compute_instance_read | string | No | |
overriden_scopes.compute_instance_write | string | No | |
overriden_scopes.compute_template_read | string | No | |
overriden_scopes.compute_template_write | string | No | |
overriden_scopes.compute_gputype_read | string | No | |
overriden_scopes.compute_region_read | string | No | |
overriden_scopes.compute_volume_read | string | No | |
overriden_scopes.compute_volume_write | string | No | |
overriden_scopes.compute_snapshot_read | string | No | |
overriden_scopes.compute_snapshot_write | string | No | |
overriden_scopes.compute_usage_read | string | No | |
overriden_scopes.compute_key_read | string | No | |
overriden_scopes.compute_key_write | string | No | |
overriden_scopes.compute_service_read | string | No | |
overriden_scopes.compute_service_write | string | No | |
overriden_scopes.compute_deployment_read | string | No | |
overriden_scopes.compute_deployment_write | string | No | |
overriden_scopes.compute_domain_read | string | No | |
overriden_scopes.compute_domain_write | string | No | |
overriden_scopes.compute_envvar_read | string | No | |
overriden_scopes.compute_envvar_write | string | No | |
overriden_scopes.healthcare_patient_read | string | No | |
overriden_scopes.healthcare_patient_write | string | No | |
overriden_scopes.healthcare_practitioner_read | string | No | |
overriden_scopes.healthcare_practitioner_write | string | No | |
overriden_scopes.healthcare_location_read | string | No | |
overriden_scopes.healthcare_location_write | string | No | |
overriden_scopes.healthcare_appointment_read | string | No | |
overriden_scopes.healthcare_appointment_write | string | No | |
overriden_scopes.healthcare_slot_read | string | No | |
overriden_scopes.healthcare_slot_write | string | No | |
overriden_scopes.healthcare_encounter_read | string | No | |
overriden_scopes.healthcare_encounter_write | string | No | |
overriden_scopes.healthcare_condition_read | string | No | |
overriden_scopes.healthcare_condition_write | string | No | |
overriden_scopes.healthcare_allergy_read | string | No | |
overriden_scopes.healthcare_allergy_write | string | No | |
overriden_scopes.healthcare_medication_read | string | No | |
overriden_scopes.healthcare_medication_write | string | No | |
overriden_scopes.healthcare_observation_read | string | No | |
overriden_scopes.healthcare_observation_write | string | No | |
overriden_scopes.healthcare_immunization_read | string | No | |
overriden_scopes.healthcare_immunization_write | string | No | |
overriden_scopes.healthcare_document_read | string | No | |
overriden_scopes.healthcare_document_write | string | No | |
overriden_scopes.healthcare_coverage_read | string | No | |
overriden_scopes.healthcare_coverage_write | string | No | |
overriden_scopes.healthcare_procedure_read | string | No | |
overriden_scopes.healthcare_procedure_write | string | No | |
overriden_scopes.healthcare_report_read | string | No | |
overriden_scopes.healthcare_report_write | string | No | |
overriden_scopes.healthcare_careplan_read | string | No | |
overriden_scopes.healthcare_careplan_write | string | No | |
overriden_scopes.healthcare_goal_read | string | No | |
overriden_scopes.healthcare_goal_write | string | No | |
overriden_scopes.property_listing_read | string | No | |
overriden_scopes.property_listing_write | string | No | |
overriden_scopes.property_unittype_read | string | No | |
overriden_scopes.property_guest_read | string | No | |
overriden_scopes.property_guest_write | string | No | |
overriden_scopes.property_reservation_read | string | No | |
overriden_scopes.property_reservation_write | string | No | |
overriden_scopes.property_availability_read | string | No | |
overriden_scopes.property_quote_read | string | No | |
overriden_scopes.property_quote_write | string | No | |
overriden_scopes.property_review_read | string | No | |
overriden_scopes.property_review_write | string | No | |
overriden_scopes.property_conversation_read | string | No | |
overriden_scopes.property_conversation_write | string | No | |
overriden_scopes.plm_part_read | string | No | |
overriden_scopes.plm_part_write | string | No | |
overriden_scopes.plm_bomline_read | string | No | |
overriden_scopes.plm_bomline_write | string | No | |
overriden_scopes.plm_document_read | string | No | |
overriden_scopes.plm_document_write | string | No | |
overriden_scopes.plm_change_read | string | No | |
overriden_scopes.plm_change_write | string | No | |
overriden_scopes.plm_category_read | string | No | |
overriden_scopes.plm_category_write | string | No | |
success_redirect | string | No | Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by /oauth/code/{workspace}/{env}/{integration}. |
failure_redirect | string | No | Post-OAuth failure URL for marketplace installs. Used by /oauth/code/{workspace}/{env}/{integration}. |
auth | object | No | |
auth.client_id | string | No | |
auth.client_secret | string | No | |
auth.consumer_key | string | No | |
auth.consumer_secret | string | No | |
auth.pem | string | No | the PEM X.509 certificate in Base64 ASCII format |
auth.key | string | No | the private KEY X.509 certificate in Base64 ASCII format |
auth.dev_api_key | string | No | |
auth.saml_idp_url | string | No | the SAML IdP SSO/login URL for end-user SAML login |
auth.saml_idp_entity_id | string | No | the SAML IdP issuer/entity ID |
auth.saml_pem | string | No | the SAML IdP signing certificate; PEM X.509 in Base64 ASCII format |
auth.needs_pkce | boolean | No | opt-in PKCE for OAuth2 when the integration app or org requires it |
secretsmanager_id | string | No | the ID of the SecretsManager object |
secretsmanager_key | string | No | the key/path/name of the secret within the vault |
Errors
Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).
{
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to unified.to API; max requests per minute: N"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not supported by this integration. |
Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.
429 Too Many Requests
A 429 has two possible sources:
- The integration's own rate limit, passed through.
- Unified's workspace limit: a rolling 60 seconds, set by plan, with the message
Too many requests to unified.to API; max requests per minute: N.
const options = {
method: 'PUT',
url: 'https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
data: undefined,
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?