https://docs.prospectis.immo/assets/js/90042d4a.e93c526d.js

1"use strict";(self.webpackChunkprospectis=self.webpackChunkprospectis||[]).push([[6162],{67753:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>u,contentTitle:()=>b,default:()=>f,frontMatter:()=>d,metadata:()=>y,toc:()=>g});var i=a(87462),s=(a(67294),a(3905)),l=a(26389),p=a(94891),n=a(75190),r=a(47507),o=a(24310),m=a(63303),c=(a(75035),a(85162));const d={id:"update-a-batch-of-people",title:"Update a batch of people",description:"Update a batch of people",sidebar_label:"Update a batch of people",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"string",enum:["letterboxes"]},name:"include",in:"query"}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"object",properties:{keye:{title:"Person",type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},phone_number:{type:"string",nullable:!0},email:{type:"string",nullable:!0},estate:{type:"string",nullable:!0},visibility:{type:"string"},editability:{type:"string"}}}}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{title:"PersonResource",allOf:[{title:"Person",type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},phone_number:{type:"string",nullable:!0},email:{type:"string",nullable:!0},estate:{type:"string",nullable:!0},visibility:{type:"string"},editability:{type:"string"}}},{type:"object",properties:{id:{type:"integer"},name:{type:"string"},visibility:{type:"string"},editability:{type:"string"},user_id:{type:"integer"},created_at:{type:"string",nullable:!0,format:"date-time"},updated_at:{type:"string",nullable:!0,format:"date-time"},deleted_at:{type:"string",nullable:!0,format:"date-time"}}}]}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["People"],description:"Update a batch of people",method:"patch",path:"/api/people/batch",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:{keye:{first_name:"string",last_name:"string",phone_number:"string",email:"string",estate:"string",visibility:"string",editability:"string"}}},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Update a batch of people",description:{type:"text/plain"},url:{path:["api","people","batch"],host:["{{baseUrl}}"],query:[{disabled:!1,key:"include",value:""}],variable:[]},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},b=void 0,y={unversionedId:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-people",id:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-people",title:"Update a batch of people",description:"Update a batch of people",source:"@site/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-people.api.mdx",sourceDirName:"prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2",slug:"/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-people",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/update-a-batch-of-people",draft:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-a-batch-of-people",title:"Update a batch of people",description:"Update a batch of people",sidebar_label:"Update a batch of people",hide_title:!0,hide_table_of_contents:!0,api:{parameters:[{schema:{type:"string",enum:["letterboxes"]},name:"include",in:"query"}],requestBody:{content:{"application/json":{schema:{type:"object",properties:{resources:{type:"object",properties:{keye:{title:"Person",type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},phone_number:{type:"string",nullable:!0},email:{type:"string",nullable:!0},estate:{type:"string",nullable:!0},visibility:{type:"string"},editability:{type:"string"}}}}}}}}}},responses:{200:{description:"OK",content:{"application/json":{schema:{type:"object",properties:{data:{type:"array",items:{title:"PersonResource",allOf:[{title:"Person",type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},phone_number:{type:"string",nullable:!0},email:{type:"string",nullable:!0},estate:{type:"string",nullable:!0},visibility:{type:"string"},editability:{type:"string"}}},{type:"object",properties:{id:{type:"integer"},name:{type:"string"},visibility:{type:"string"},editability:{type:"string"},user_id:{type:"integer"},created_at:{type:"string",nullable:!0,format:"date-time"},updated_at:{type:"string",nullable:!0,format:"date-time"},deleted_at:{type:"string",nullable:!0,format:"date-time"}}}]}}}}}}},401:{description:"Unauthenticated"}

1,403:{description:"Unauthorized"},404:{description:"Resource not found"},422:{description:"Validation error"}},tags:["People"],description:"Update a batch of people",method:"patch",path:"/api/people/batch",servers:[{url:"https://manager.prospectis.immo",description:"Default Environment"}],security:[{BearerAuth:[]}],securitySchemes:{BearerAuth:{type:"http",scheme:"bearer"}},jsonRequestBodyExample:{resources:{keye:{first_name:"string",last_name:"string",phone_number:"string",email:"string",estate:"string",visibility:"string",editability:"string"}}},info:{title:"Prospectis",version:"1.0.0"},postman:{name:"Update a batch of people",description:{type:"text/plain"},url:{path:["api","people","batch"],host:["{{baseUrl}}"],query:[{disabled:!1,key:"include",value:""}],variable:[]},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:"Create a batch of people",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/create-a-batch-of-people"},next:{title:"Delete a batch of people",permalink:"/docs/prospectis-37cb-4770-bc5660ebe1e4-a907-65772db2/delete-a-batch-of-people"}},u={},g=[{value:"Update a batch of people",id:"update-a-batch-of-people",level:2}],h={toc:g};function f(e){let{components:t,...a}=e;return(0,s.kt)("wrapper",(0,i.Z)({},h,a,{components:t,mdxType:"MDXLayout"}),(0,s.kt)("h2",{id:"update-a-batch-of-people"},"Update a batch of people"),(0,s.kt)("p",null,"Update a batch of people"),(0,s.kt)("details",{style:{marginBottom:"1rem"},"data-collapsed":!1,open:!0},(0,s.kt)("summary",{style:{}},(0,s.kt)("strong",null,"Query Parameters")),(0,s.kt)("div",null,(0,s.kt)("ul",null,(0,s.kt)(n.Z,{className:"paramsItem",param:{schema:{type:"string",enum:["letterboxes"]},name:"include",in:"query"},mdxType:"ParamsItem"})))),(0,s.kt)(p.Z,{mdxType:"MimeTabs"},(0,s.kt)(c.Z,{label:"application/json",value:"application/json-schema",mdxType:"TabItem"},(0,s.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,s.kt)("summary",{style:{textAlign:"left"}},(0,s.kt)("strong",null,"Request Body")),(0,s.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.kt)("ul",{style:{marginLeft:"1rem"}},(0,s.kt)(o.Z,{collapsible:!0,className:"schemaItem",mdxType:"SchemaItem"},(0,s.kt)("details",{style:{}},(0,s.kt)("summary",{style:{}},(0,s.kt)("strong",null,"resources"),(0,s.kt)("span",{style:{opacity:"0.6"}}," object")),(0,s.kt)("div",{style:{marginLeft:"1rem"}},(0,s.kt)(o.Z,{collapsible:!0,className:"schemaItem",mdxType:"SchemaItem"},(0,s.kt)("details",{style:{}},(0,s.kt)("summary",{style:{}},(0,s.kt)("strong",null,"keye"),(0,s.kt)("span",{style:{opacity:"0.6"}}," object")),(0,s.kt)("div",{style:{marginLeft:"1rem"}},(0,s.kt)(o.Z,{collapsible:!1,name:"first_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"last_name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"phone_number",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",nullable:!0},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",nullable:!0},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"estate",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",nullable:!0},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"visibility",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"},mdxType:"SchemaItem"}),(0,s.kt)(o.Z,{collapsible:!1,name:"editability",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"},mdxType:"SchemaItem"}))))))))))),(0,s.kt)("div",null,(0,s.kt)(l.Z,{mdxType:"ApiTabs"},(0,s.kt)(c.Z,{label:"200",value:"200",mdxType:"TabItem"},(0,s.kt)("div",null,(0,s.kt)("p",null,"OK")),(0,s.kt)("div",null,(0,s.kt)(p.Z,{schemaType:"response",mdxType:"MimeTabs"},(0,s.kt)(c.Z,{label:"application/json",value:"application/json",mdxType:"TabItem"},(0,s.kt)(m.Z,{mdxType:"SchemaTabs"},(0,s.kt)(c.Z,{label:"Schema",value:"Schema",mdxType:"TabItem"},(0,s.kt)("details",{style:{},"data-collapsed":!1,open:!0},(0,s.kt)("summary",{style:{textAlign:"left"}},(0,s.kt)("strong",null,"Schema")),(0,s.kt)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.kt)("ul",{style:{marginLeft:"1rem"}},(0,s.kt)(o.Z,{collapsible:!1,name:"data",required:!1,schemaName:"object[]",qualifierMessage:void 0,schema:{type:"array",items:{title:"PersonResource",allOf:[{title:"Person",type:"object",properties:{first_name:{type:"string"},last_name:{type:"string"},phone_number:{type:"string",nullable:!0},email:{type:"string",nullable:!0},estate:{type:"string",nullable:!0},visibility:{type:"string"},editability:{type:"string"}}},{type:"object",properties:{id:{type:"integer"},name:{type:"string"},visibility:{type:"string"},editability:{type:"string"},user_id:{type:"integer"},created_at:{type:"string",nullable:!0,format:"date-time"},updated_at:{type:"string",nullable:!0,format:"date-time"},deleted_at:{type:"string",nullable:!0,format:"date-time"}}}]}},mdxType:"SchemaItem"})))),(0,s.kt)(c.Z,{label:"Example (from schema)",value:"Example (from schema)",mdxType:"TabItem"}

1,(0,s.kt)(r.Z,{responseExample:'{\n  "data": [\n    {\n      "first_name": "string",\n      "last_name": "string",\n      "phone_number": "string",\n      "email": "string",\n      "estate": "string",\n      "visibility": "string",\n      "editability": "string",\n      "id": 0,\n      "name": "string",\n      "user_id": 0,\n      "created_at": "2023-11-19T22:31:14.721Z",\n      "updated_at": "2023-11-19T22:31:14.721Z",\n      "deleted_at": "2023-11-19T22:31:14.721Z"\n    }\n  ]\n}',language:"json",mdxType:"ResponseSamples"}))))))),(0,s.kt)(c.Z,{label:"401",value:"401",mdxType:"TabItem"},(0,s.kt)("div",null,(0,s.kt)("p",null,"Unauthenticated")),(0,s.kt)("div",null)),(0,s.kt)(c.Z,{label:"403",value:"403",mdxType:"TabItem"},(0,s.kt)("div",null,(0,s.kt)("p",null,"Unauthorized")),(0,s.kt)("div",null)),(0,s.kt)(c.Z,{label:"404",value:"404",mdxType:"TabItem"},(0,s.kt)("div",null,(0,s.kt)("p",null,"Resource not found")),(0,s.kt)("div",null)),(0,s.kt)(c.Z,{label:"422",value:"422",mdxType:"TabItem"},(0,s.kt)("div",null,(0,s.kt)("p",null,"Validation error")),(0,s.kt)("div",null)))))}f.isMDXComponent=!0}}]);