--- title: "Update workspace integration" url: "https://docs.unified.to/unified/workspaceintegration/Update_workspace_integration" description: "Update workspace integration with Unified's Workspaceintegration API (PUT /unified/workspaceintegration/{id})." date: "2026-11-08T19:47:06.331Z" updated: "2026-11-08T19:47:06.331Z" --- # Update workspace integration Updated: November 8, 2026 PUT/unified/workspaceintegration/{id} ## Parameters **id**string required ID of the Workspaceintegration ## Payload **id**string **created\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **updated\_at**date-time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) **workspace\_id**string (reference to KmsSpace) **integration\_type**string required **is\_active**boolean required **api\_url**string **authorize\_url**string **token\_url**string **refresh\_url**string **base\_url**string **prompt\_region**boolean **use\_unified\_redirect**boolean **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) **environment**string authentication environment **categories** enum array Valid 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" derived from `permissions` (plus the auth, passthrough and saml categories, which have no permissions) **permissions** enum array Valid 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" the unified permission scopes enabled for this integration; requested when an authorization URL omits `scopes` **overriden\_scopes**object **success\_redirect**string Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by `/oauth/code/{workspace}/{env}/{integration}`. **failure\_redirect**string Post-OAuth failure URL for marketplace installs. Used by `/oauth/code/{workspace}/{env}/{integration}`. **auth**object **secretsmanager\_id**string the ID of the SecretsManager object **secretsmanager\_key**string the key/path/name of the secret within the vault ## Returns [WorkspaceIntegration](https://docs.unified.to/unified/workspaceintegration/model.md) | 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). ```json { "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`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const id = '1234'; const results = await sdk.unified.updateUnifiedWorkspaceintegration({ id: '5dc201f9414446e39b2045aa', }); ``` ### Node.js (axios) ```javascript const options = { method: 'PUT', url: 'https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, data: undefined, }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("PUT", "https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8 req, _ := http.NewRequest("PUT", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8" headers = { "accept": "application/json", "authorization": "....." } response = requests.put(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request PUT \ --url 'https://api.unified.to/unified/workspaceintegration/5de520f96e439b002043d8d8' \ --header 'accept: application/json' \ --header 'authorization: .....' ```