https://docs.prospectis.immo/assets/js/69ce9d68.afb968f2.js

1"use strict";(self.webpackChunkprospectis=self.webpackChunkprospectis||[]).push([[828],{50376:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>y,contentTitle:()=>u,default:()=>k,frontMatter:()=>m,metadata:()=>b,toc:()=>g});var p=a(87462),o=(a(67294),a(3905)),l=a(26389),s=a(94891),r=a(75190),i=a(47507),n=a(24310),c=a(63303),d=(a(75035),a(85162));const m={id:"toggle-people",title:"Toggle people",description:"Toggle people",sidebar_label:"Toggle people",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"integer"},name:"letterbox",in:"path",required:!0}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"array",items:{type:"object",description:"A key-value pairs, where keys are relation resource IDs and values are objects representing pivot fields"}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{attached:{type:"array",items:{type:"integer"}},detached:{type:"array",items:{type:"integer"}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["Letterbox People"],description:"Toggle people",method:"patch",path:"/api/letterboxes/{letterbox}/people/toggle",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:[{}]},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Toggle people",description:{type:"text/plain"},url:{path:["api","letterboxes",":letterbox","people","toggle"],host:["{{baseUrl}}"],query:[],variable:[{disabled:!1,description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"letterbox"}]},header:[{key:"Content-Type",value:"application/json"},{key:"Accept",value:"application/json"}],method:"PATCH",body:{mode:"raw",raw:'""',options:{raw:{language:"json"}}}}},sidebar_class_name:"patch api-method",info_path:"docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/prospectis",custom_edit_url:null},u=void 0,b={unversionedId:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/toggle-people",id:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/toggle-people",title:"Toggle people",description:"Toggle people",source:"@site/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/toggle-people.api.mdx",sourceDirName:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2",slug:"/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/toggle-people",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/toggle-people",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"toggle-people",title:"Toggle people",description:"Toggle people",sidebar_label:"Toggle people",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"integer"},name:"letterbox",in:"path",required:!0}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"array",items:{type:"object",description:"A key-value pairs, where keys are relation resource IDs and values are objects representing pivot fields"}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{attached:{type:"array",items:{type:"integer"}},detached:{type:"array",items:{type:"integer"}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["Letterbox People"],description:"Toggle people",method:"patch",path:"/api/letterboxes/{letterbox}/people/toggle",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:[{}]},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Toggle people",description:{type:"text/plain"},url:{path:["api","letterboxes",":letterbox","people","toggle"],host:["{{baseUrl}}"],query:[],variable:[{disabled:!1,description:{content:"(Required) ",type:"text/plain"},type:"any",value:"",key:"letterbox"}]},header:[{key:"Content-Type",value:"application/json"},{key:"Accept",value:"application/json"}],method:"PATCH",body:{mode:"raw",raw:'""',options:{raw:{language:"json"}}}}},sidebar_class_name:"patch api-method",info_path:"docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/prospectis",custom_edit_url:null},sidebar:"openApiSidebar",previous:{title:"Sync people",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/sync-people"},next:{title:"Update pivot",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-pivot"}},y={},g=[{value:"Toggle people",id:"toggle-people",level:2}],h={toc:g};function k(e){let{components:t,...a}=e;return(0,o.kt)("wrapper",(0,p.Z)({},h,a,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"toggle-people"},"Toggle people"),(0,o.kt)("p",null,"Toggle people"),(0,o.kt)("details",{style:{marginBottom:"1rem"},"data-collapsed":!1,open:!0},(0,o.kt)("summary",{style:{}},(0,o.kt)("strong",null,"Path Parameters")),(0,o.kt)("div",null,(0,o.kt)("ul",null,(0,o.kt)(r.Z,{className:"paramsItem",param:{schema:{type:"integer"},name:"letterbox",in:"path",required:!0},mdxType:"ParamsItem"})))),(0,o.kt)(s.Z,{mdxType:"MimeTabs"},(0,o.kt)(d.Z,{label:"application/json",value:"application/json-schema",mdxType:"TabItem"},(0,o.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,o.kt)("summary",{style:{textAlign:"left"}},(0,o.kt)("strong",null,"Request Body")),(0,o.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,o.kt)("ul",{style:{marginLeft:"1rem"}},(0,o.kt)(n.Z,{collapsible:!1,name:"resources",required:!1,schemaName:"object[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"object",description:"A key-value pairs, where keys are relation resource IDs and values are objects representing pivot fields"}},mdxType:"SchemaItem"}))))),(0,o.kt)("div",null,(0,o.kt)(l.Z,{mdxType:"ApiTabs"},(0,o.kt)(d.Z,{label:"200",value:"200",mdxType:"TabItem"},(0,o.kt)("div",null,(0,o.kt)("p",null,"OK")),(0,o.kt)("div",null,(0,o.kt)(s.Z,{schemaType:"response",mdxType:"MimeTabs"},(0,o.kt)(d.Z,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,o.kt)(c.Z,{mdxType:"SchemaTabs"},(0,o.kt)(d.Z,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,o.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,o.kt)("summary",{style:{textAlign:"left"}},(0,o.kt)("strong",null,"Schema")),(0,o.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,o.kt)("ul",{style:{marginLeft:"1rem"}},(0,o.kt)(n.Z,{collapsible:!1,name:"attached",required:!1,schemaName:"integer[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"integer"}},mdxType:"SchemaItem"}),(0,o.kt)(n.Z,{collapsible:!1,name:"detached",required:!1,schemaName:"integer[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"integer"}},mdxType:"SchemaItem"})))),(0,o.kt)(d.Z,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"},(0,o.kt)(i.Z,{responseExample:'{\n  "attached": [\n    0\n  ],\n  "detached": [\n    0\n  ]\n}',language:"json",mdxType:"ResponseSamples"}))))))),(0,o.kt)(d.Z,{label:"401",value:"401",mdxType:"TabItem"},(0,o.kt)("div",null,(0,o.kt)("p",null,"Unauthenticated")),(0,o.kt)("div",null)),(0,o.kt)(d.Z,{label:"403",value:"403",mdxType:"TabItem"},(0,o.kt)("div",null,(0,o.kt)("p",null,"Unauthorized")),(0,o.kt)("div",null)),(0,o.kt)(d.Z,{label:"404",value:"404",mdxType:"TabItem"},(0,o.kt)("div",null,(0,o.kt)("p",null,"Resource not found")),(0,o.kt)("div",null)),(0,o.kt)(d.Z,{label:"422",value:"422",mdxType:"TabItem"},(0,o.kt)("div",null,(0,o.kt)("p",null,"Validation error")),(0,o.kt)("div",null)))))}k.isMDXComponent=!0}}]);