{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
Custom objects
Update objects in batch
Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.
people and companiesreplace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}.
A record whose ID designates an object of another type, or of another group, fails as not found.
The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated.
An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.
{
"error": {
"code": "INVALID_REQUEST",
"message": "The request was invalid.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#bad-request",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "No valid API key provided.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unauthorized",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "FORBIDDEN",
"message": "The API key doesn’t have permissions to perform the request.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#forbidden",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "The requested resource was not found.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#not-found",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "A request with the same Idempotency-Key is still being processed. Retry once it has completed.",
"documentationUrl": "https://developer.folk.app/api-reference/idempotency#errors",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "UNPROCESSABLE_ENTITY",
"message": "Invalid query parameters",
"documentationUrl": "https://developer.folk.app/api-reference/errors#unprocessable-entity",
"details": {
"issues": [
{
"code": "too_small",
"minimum": 1,
"type": "number",
"inclusive": true,
"exact": false,
"message": "Number must be greater than or equal to 1",
"path": [
"limit"
]
}
]
},
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is currently unavailable.",
"documentationUrl": "https://developer.folk.app/api-reference/errors#service-unavailable",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2025-10-01T12:00:00Z"
}
}
Update up to 100 existing objects of a given type in one request, identified by their id.Set the objectType path parameter to the name of the object type you want to update — Deals, Projects, Applications, or any other object type defined in the group. See Custom objects to find the object types available in a group. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group. A record whose id designates an object of another type, or of another group, fails as not found.Each record takes the same fields as update an object and is updated on its own: a record that fails, for instance because of an unknown custom field, does not prevent the others from being updated. See batch requests for the 100-record limit and how to read the response. Each object comes back in full, as in the response of update an object. If the API key cannot update objects in the group, every record fails.
people and companiesreplace the people and companies of the object:
you must provide the entire list, not just the ones you want to add. Leave
them out to keep them unchanged.
People and companies are given by ID, and must already be in the group: an unknown one, or one not in the group, is ignored.The records of one object are merged into one update, in the order you sent them: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. This is not always the same as sending the records one after the other: a record with an invalid custom field value fails every record of its object, including the earlier ones, which sent on their own would have been applied before it.A record that succeeded but whose people, companies or custom field values could not all be set carries a warnings list explaining what was not applied.
A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.
The name of the object type, as shown in the folk app, such as Deals. It is case-sensitive, and spaces must be URL-encoded, e.g. Job%20Applications. See how to find the object types of a group.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Folk Developer Portal","description":"Developer portal and API reference of folk","colors":{"primary":"#000000","light":"#ffffff","dark":"#222222"},"logo":{"light":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8","dark":"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-dark.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=f7a85c0692d36cf4ae95ba0cb3a13827"},"favicon":{"light":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-light.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=f507f5945e391292cf6679ecee54f2a0","dark":"https://mintcdn.com/folk-cf968f5e/HcSGFJR-HRVkFe3E/assets/favicon-dark.svg?fit=max\u0026auto=format\u0026n=HcSGFJR-HRVkFe3E\u0026q=85\u0026s=26f07b15afad6f7a4467054d25a0f955"},"api":{"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python","ruby","go","php"]}},"navbar":{"links":[{"href":"intercom://show","label":"Chat with support"},{"href":"https://www.folk.app/contact-sales","label":"Get a demo"}],"primary":{"type":"button","label":"Open app","href":"https://app.folk.app"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/folkhq","x":"https://twitter.com/folkhq","youtube":"https://www.youtube.com/channel/UCs3bswOUZvkouum7Rdx4i5w"}},"integrations":{"intercom":{"appId":"rn8e78eq"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"folk-cf968f5e","hasAudioNarration":false,"actualSubdomain":"folk-cf968f5e","customDomains":["developer.folk.app"],"gitSource":{"type":"github","owner":"folkapp-mintlify-prod","repo":"api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aec9b5622f813687c154934","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":102},{"language":"default","tag":"Available endpoints","count":91},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Campaigns","count":15},{"language":"default","tag":"Introduction","count":11},{"language":"default","tag":"Core concepts","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Companies","count":8},{"language":"default","tag":"Custom objects","count":8},{"language":"default","tag":"People","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGHInHEVA.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGGInHEVA.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Bricolage Grotesque';\n font-style: normal;\n font-weight: 200 800;\n font-stretch: 100%;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/bricolagegrotesque/v9/3y9K6as8bTXq_nANBjzKo3IeZx8z6up5BeSl9D4dj_x9PpZBMlGIInE.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--font-family-headings-custom: 'Bricolage Grotesque', sans-serif}h1,h2,h3,h4,h5,h6{font-optical-sizing:auto;font-weight:600;font-style:normal;font-variation-settings:'wdth' 100}.dark{--background-dark: 25 25 25}.dark #topbar-cta-button>a>span,#home-cta-button{border:1px solid rgb(var(--gray-800))}.prose :where(a):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){border-color:rgb(var(--primary-dark))}.dark .prose :where(a):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){border-color:rgb(var(--primary-light))}.nav-tag-pill-text{font-weight:500!important;text-shadow:none;color:#ffffff!important;background-color:#2563eb!important}.dark .nav-tag-pill-text{background-color:#3b82f6!important}"}],"page":{"pagePath":"api-reference/custom-objects/update-objects-in-batch","slug":"/api-reference/custom-objects/update-objects-in-batch","pageMetadata":{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/update","keywords":["deal","deals"],"title":"Update objects in batch","description":"Update up to 100 existing objects of one type in a group, each with the fields `PATCH /v1/groups/{groupId}/{objectType}/{objectId}` accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.\n\n`people` and `companies` **replace** the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in `PATCH /v1/groups/{groupId}/{objectType}/{objectId}`.\n\nA record whose ID designates an object of another type, or of another group, fails as not found.\n\nThe records of one object are merged into one update, in request order: the last value given for a field wins, and `customFieldValues` are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated.\n\nAn object type that does not exist in the group fails the whole request with a `404`, whose message lists the object types of the group.","href":"/api-reference/custom-objects/update-objects-in-batch"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Update up to 100 existing objects of one type in a group, each with the fields \", _jsx(_components.code, {\n children: \"PATCH /v1/groups/{groupId}/{objectType}/{objectId}\"\n }), \" accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"people\"\n }), \" and \", _jsx(_components.code, {\n children: \"companies\"\n }), \" \", _jsx(_components.strong, {\n children: \"replace\"\n }), \" the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in \", _jsx(_components.code, {\n children: \"PATCH /v1/groups/{groupId}/{objectType}/{objectId}\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"A record whose ID designates an object of another type, or of another group, fails as not found.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The records of one object are merged into one update, in request order: the last value given for a field wins, and \", _jsx(_components.code, {\n children: \"customFieldValues\"\n }), \" are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An object type that does not exist in the group fails the whole request with a \", _jsx(_components.code, {\n children: \"404\"\n }), \", whose message lists the object types of the group.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Update up to 100 existing objects of a given type in one request, identified by their `,_jsx(_components.code,{children:`id`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Set the `,_jsx(_components.code,{children:`objectType`}),` path parameter to the name of the object type you want to update — `,_jsx(_components.code,{children:`Deals`}),`, `,_jsx(_components.code,{children:`Projects`}),`, `,_jsx(_components.code,{children:`Applications`}),`, or any other object type defined in the group. See `,_jsx(_components.a,{href:`/core-concepts/custom-objects#find-the-object-types-of-a-group`,children:`Custom objects`}),` to find the object types available in a group. An object type that does not exist in the group fails the whole request with a `,_jsx(_components.code,{children:`404`}),`, whose message lists the object types of the group. A record whose `,_jsx(_components.code,{children:`id`}),` designates an object of another type, or of another group, fails as not found.`]}),`\n`,_jsxs(_components.p,{children:[`Each record takes the same fields as `,_jsx(_components.a,{href:`/api-reference/custom-objects/update-an-object`,children:`update an object`}),` and is updated on its own: a record that fails, for instance because of an unknown custom field, does not prevent the others from being updated. See `,_jsx(_components.a,{href:`/api-reference/batch-requests`,children:`batch requests`}),` for the 100-record limit and how to read the response. Each object comes back in full, as in the response of `,_jsx(_components.a,{href:`/api-reference/custom-objects/update-an-object`,children:`update an object`}),`. If the API key cannot update objects in the group, every record fails.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`people`}),` and `,_jsx(_components.code,{children:`companies`}),` `,_jsx(_components.strong,{children:`replace`}),` the people and companies of the object:\nyou must provide the entire list, not just the ones you want to add. Leave\nthem out to keep them unchanged.`]})}),`\n`,_jsx(_components.p,{children:`People and companies are given by ID, and must already be in the group: an unknown one, or one not in the group, is ignored.`}),`\n`,_jsxs(_components.p,{children:[`The records of one object are merged into one update, in the order you sent them: the last value given for a field wins, and `,_jsx(_components.code,{children:`customFieldValues`}),` are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. This is not always the same as sending the records one after the other: a record with an invalid custom field value fails every record of its object, including the earlier ones, which sent on their own would have been applied before it.`]}),`\n`,_jsxs(_components.p,{children:[`A record that succeeded but whose people, companies or custom field values could not all be set carries a `,_jsx(_components.code,{children:`warnings`}),` list explaining what was not applied.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/update","keywords":["deal","deals"],"title":"Update objects in batch","description":"Update up to 100 existing objects of one type in a group, each with the fields `PATCH /v1/groups/{groupId}/{objectType}/{objectId}` accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.\n\n`people` and `companies` **replace** the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in `PATCH /v1/groups/{groupId}/{objectType}/{objectId}`.\n\nA record whose ID designates an object of another type, or of another group, fails as not found.\n\nThe records of one object are merged into one update, in request order: the last value given for a field wins, and `customFieldValues` are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated.\n\nAn object type that does not exist in the group fails the whole request with a `404`, whose message lists the object types of the group.","href":"/api-reference/custom-objects/update-objects-in-batch"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/folk-cf968f5e/c239747596c4df94/intercom.js"],"openApiReferenceData":{"operation":{"security":["98204c35-aea2-485d-9b56-d3995e90a084"],"operationId":"batchUpdateDeals","summary":"Update objects in batch","description":"Update up to 100 existing objects of one type in a group, each with the fields `PATCH /v1/groups/{groupId}/{objectType}/{objectId}` accepts. Each record is updated on its own: one that fails does not prevent the others from being updated.\n\n`people` and `companies` **replace** the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in `PATCH /v1/groups/{groupId}/{objectType}/{objectId}`.\n\nA record whose ID designates an object of another type, or of another group, fails as not found.\n\nThe records of one object are merged into one update, in request order: the last value given for a field wins, and `customFieldValues` are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated.\n\nAn object type that does not exist in the group fails the whole request with a `404`, whose message lists the object types of the group.","tags":["Custom objects"],"parameters":["6ecc5d15-8265-4a26-bdba-c5ce40d7f0c7","0ea6b5df-c68a-4023-9455-bc77d5af0fd5","cb5b9aed-1078-4898-bf5a-79e9b794900a"],"requestBody":"f4921f41-5996-4a49-bfb7-16ce93bb2d51","responses":{"200":"365a01de-7589-42a9-bdbd-de032deb4580","400":"9fb03717-4e45-4aa3-95ca-58fcfd68c302","401":"aaccc5f2-a3cb-478c-b7d6-a5c11adca40f","403":"fd904088-9062-496f-b3ae-df8b8fa9c0c3","404":"a58eb613-4138-46f6-bf5c-5a05cd51b3e3","409":"04b0b3c9-af02-4fb1-b77f-d17e9b73f59c","422":"c1ef6ccb-0f9a-48f6-b93b-b7e5eb69eb47","429":"705d3505-2da3-427d-99ce-4a1cd78eb954","500":"05c4b074-55ff-4865-9bfb-c7e3c7db161d","503":"70f6104a-3d12-40a5-85f2-4e9b83c61c8c"},"method":"post","type":"path","servers":["fe19c3b8-6b7d-41af-b676-53250d3345e8"],"path":"/v1/groups/{groupId}/{objectType}/batch/update","baseUrlOptions":["https://api.folk.app"],"title":"Update objects in batch","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","ruby","go","php"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6ecc5d15-8265-4a26-bdba-c5ce40d7f0c7":{"schema":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"description":"The ID of the group the objects belong to. Can be retrieved from the [List groups](/api-reference/groups/list-groups) endpoint.","uniqueKey":"","typeLabel":"string"},"required":true,"description":"The ID of the group the objects belong to. Can be retrieved from the [List groups](/api-reference/groups/list-groups) endpoint.","example":"grp_bc984b3f-0386-434d-82d7-a91eb6badd71","name":"groupId","in":"path"},"0ea6b5df-c68a-4023-9455-bc77d5af0fd5":{"schema":{"type":"string","maxLength":500,"isRequired":true,"description":"The name of the object type, as shown in the folk app, such as `Deals`. It is case-sensitive, and spaces must be URL-encoded, e.g. `Job%20Applications`. See [how to find the object types of a group](/core-concepts/custom-objects#find-the-object-types-of-a-group).","uniqueKey":"","typeLabel":"string"},"required":true,"description":"The name of the object type, as shown in the folk app, such as `Deals`. It is case-sensitive, and spaces must be URL-encoded, e.g. `Job%20Applications`. See [how to find the object types of a group](/core-concepts/custom-objects#find-the-object-types-of-a-group).","example":"Deals","name":"objectType","in":"path"},"cb5b9aed-1078-4898-bf5a-79e9b794900a":{"schema":{"type":"string","maxLength":255,"description":"A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.","example":"8e03978e-40d5-43e8-bc93-6894a57f9324","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"Idempotency-Key","in":"header"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":40,"maxLength":40,"description":"The ID of the object to update.","isRequired":true,"uniqueKey":"records.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","maxLength":1000,"description":"The name of the object.","example":"Project Alpha","uniqueKey":"records.items.[INDEX].name","typeLabel":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX].id","typeLabel":"string"}},"required":["id"],"additionalProperties":false,"uniqueKey":"records.items.[INDEX].companies.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"The companies associated with the object. Unknown companies, and companies not in the group of the object, are ignored.","example":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c"}],"uniqueKey":"records.items.[INDEX].companies","typeLabel":"object[]"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].people.items.[INDEX].id","typeLabel":"string"}},"required":["id"],"additionalProperties":false,"uniqueKey":"records.items.[INDEX].people.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"The people associated with the object. Unknown people, and people not in the group of the object, are ignored.","example":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}],"uniqueKey":"records.items.[INDEX].people","typeLabel":"object[]"},"customFieldValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"null","uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.0","typeLabel":"null"},{"type":"string","maxLength":5000,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.1","typeLabel":"string"},{"type":"number","maximum":1.7976931348623157e+308,"minimum":-1.7976931348623157e+308,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.2","typeLabel":"number"},{"type":"array","items":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","required":["id"],"properties":{"id":{"type":"string","minLength":40,"maxLength":40,"isRequired":true,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX].oneOf.1.id","typeLabel":"string"}},"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["email"],"properties":{"email":{"type":"string","maxLength":254,"isRequired":true,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX].oneOf.2.email","typeLabel":"string"}},"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"string · object · object"},"maxItems":1000,"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.3","typeLabel":"string · object · object[]"},{"type":"null","uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"records.items.[INDEX].customFieldValues.additionalProperties","typeLabel":"null · string · number · string · object · object[] · null"},"description":"The custom field values of the object, for the custom fields defined on its object type in the group. The format is the following:\n```json\n{\n \"\u003ccustomFieldName>\": \"\u003ccustomFieldValue>\"\n}\n```\n\nThe format of the custom field value depends on the type of the custom field:\n\n- `textField`: string, eg: `\"Foo\"`\n- `numericField`: number or numeric string, eg: `42` or `\"42\"`\n- `dateField`: ISO 8601 string (YYYY-MM-DD), eg: `\"2021-01-01\"`\n- `singleSelect`: string (option label), eg: `\"Active\"`. Use the exact option labels of the custom field (case-sensitive): an unknown label creates a new option.\n- `multipleSelect`: array of strings (option labels), eg: `[\"B2B\", \"B2C\"]`. Use the exact option labels of the custom field (case-sensitive): an unknown label creates a new option.\n- `userField`: array of objects with either `id` (workspace user id) or `email` (workspace user email) property, eg: `[{\"id\": \"usr_a23373bb-5296-4c59-b2e8-8f121707d562\"}, {\"email\": \"jane@example.com\"}]`\n\nPassing a `null` value or an empty array will unset the custom field value.","properties":{},"example":{"Status":"Qualified","Deal value":"42000","Close date":"2021-01-01","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6"},{"email":"jane@example.com"}]},"uniqueKey":"records.items.[INDEX].customFieldValues","typeLabel":"object"}},"required":["id"],"additionalProperties":false,"example":{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}],"customFieldValues":{"Status":"Won"}},"uniqueKey":"records.items.[INDEX]","typeLabel":"object"},"maxItems":100,"isRequired":true,"uniqueKey":"records","typeLabel":"object[]"}},"required":["records"],"example":{"records":[{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}],"customFieldValues":{"Status":"Won"}}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"records":[{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2"}],"customFieldValues":{"Status":"Won"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"365a01de-7589-42a9-bdbd-de032deb4580":{"description":"The outcome of each record, with each updated object.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","required":["status","data"],"properties":{"status":{"type":"string","enum":["succeeded"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.id","typeLabel":"string"},"name":{"type":"string","description":"The name of the object.","example":"Project Alpha","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.name","typeLabel":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the company.","example":"Tech Corp","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.companies","typeLabel":"object[]"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.people.items.[INDEX].id","typeLabel":"string"},"fullName":{"type":"string","description":"The name of the person.","example":"John Doe","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.people.items.[INDEX].fullName","typeLabel":"string"}},"required":["id","fullName"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.people.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.people","typeLabel":"object[]"},"createdAt":{"oneOf":[{"type":"string","minLength":20,"maxLength":40,"description":"The date and time the object was created, in ISO format.","example":"2021-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt.oneOf.0","typeLabel":"string"},{"type":"null","minLength":20,"maxLength":40,"description":"The date and time the object was created, in ISO format.","example":"2021-01-01T00:00:00.000Z","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdAt","typeLabel":"string | null"},"createdBy":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy.email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.createdBy","typeLabel":"object"},"customFieldValues":{"type":"object","additionalProperties":{"oneOf":[{"type":"null","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.0","typeLabel":"null"},{"type":"string","description":"A custom field value as a string.","example":"Value 1","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.1","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"An array of values for the custom field.","example":["Value 1","Value 2"],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.2","typeLabel":"string[]"},{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.3.items.[INDEX].id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.3.items.[INDEX].fullName","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.3.items.[INDEX].email","typeLabel":"string"}},"required":["id","fullName","email"],"description":"A user in the workspace.","example":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.3.items.[INDEX]","typeLabel":"object"},"description":"An array of users associated with the custom field.","example":[{"id":"usr_44b85098-441b-4d7f-9d72-c079b1caec45","fullName":"Jane Doe","email":"jane@example.com"},{"id":"usr_a95a1b90-8e88-4855-bc29-d47b8e2704e1","fullName":"John Doe","email":"john@example.com"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.3","typeLabel":"object[]"},{"type":"array","items":{"oneOf":[{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["person"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.0.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["company"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.1.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["id","fullName","entityType"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.id","typeLabel":"string"},"fullName":{"type":"string","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.fullName","typeLabel":"string"},"entityType":{"type":"string","enum":["object"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.2.entityType","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"object"},"description":"An array of relationships associated with the custom field.","example":[{"id":"per_183ed5cc-3182-45de-84d1-d520f2604810","fullName":"John Doe","entityType":"person"},{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","fullName":"Tech Corp","entityType":"company"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.4","typeLabel":"object[]"},{"type":"null","uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties.oneOf.5","typeLabel":"null"}],"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues.additionalProperties","typeLabel":"null · string · string[] · object[] · object[] · null"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data.customFieldValues","typeLabel":"object"}},"required":["id","name","companies","people","createdAt","createdBy","customFieldValues"],"description":"An object of any type in a group, such as a deal.","example":{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","fullName":"John Doe"}],"createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"customFieldValues":{"Status":"Qualified","Deal value":"42000","Close date":"2021-01-01","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.0.data","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.results.items.[INDEX].oneOf.0.warnings.items.[INDEX]","typeLabel":"string"},"description":"What could not be applied to this record although it succeeded, such as a group it could not be added to.","uniqueKey":"data.results.items.[INDEX].oneOf.0.warnings","typeLabel":"string[]"}},"uniqueKey":"data.results.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["status","error"],"properties":{"status":{"type":"string","enum":["failed"],"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"code":{"type":"string","example":"NOT_FOUND","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","example":"Not found.","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#not-found","isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.documentationUrl","typeLabel":"string\u003curi>"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error.details","typeLabel":"object"}},"required":["code","message","documentationUrl"],"description":"Why this record did not succeed.","example":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"},"isRequired":true,"uniqueKey":"data.results.items.[INDEX].oneOf.1.error","typeLabel":"object"}},"uniqueKey":"data.results.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"data.results.items.[INDEX]","typeLabel":"object"},"description":"One result per record, in the order of `records`: the first result is the outcome of the first record.","isRequired":true,"uniqueKey":"data.results","typeLabel":"object[]"}},"required":["results"],"example":{"results":[{"status":"succeeded","data":{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","fullName":"John Doe"}],"createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"customFieldValues":{"Status":"Qualified","Deal value":"42000","Close date":"2021-01-01","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"deprecations":{"type":"array","items":{"type":"string","uniqueKey":"deprecations.items.[INDEX]","typeLabel":"string"},"example":["This field is deprecated"],"uniqueKey":"deprecations","typeLabel":"string[]"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"results":[{"status":"succeeded","data":{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","fullName":"John Doe"}],"createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"customFieldValues":{"Status":"Qualified","Deal value":"42000","Close date":"2021-01-01","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]}},"examples":{"Example":{"title":"Example","value":{"data":{"results":[{"status":"succeeded","data":{"id":"obj_183ed5cc-3182-45de-84d1-d520f2604810","name":"Project Alpha","companies":[{"id":"com_92346499-30bf-4278-ae8e-4aa3ae2ace2c","name":"Tech Corp"}],"people":[{"id":"per_5fa60242-0756-4e31-8cca-30c2c5ff1ac2","fullName":"John Doe"}],"createdAt":"2021-01-01T00:00:00.000Z","createdBy":{"id":"usr_bc984b3f-0386-434d-82d7-a91eb6badd71","fullName":"John Doe","email":"john.doe@example.com"},"customFieldValues":{"Status":"Qualified","Deal value":"42000","Close date":"2021-01-01","Assignee":[{"id":"usr_c3606e3b-0a92-4849-90e5-88a8d3f388d6","fullName":"Jane Doe","email":"jane@example.com"}]}}},{"status":"failed","error":{"code":"NOT_FOUND","message":"Not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found"}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"9fb03717-4e45-4aa3-95ca-58fcfd68c302":{"description":"The request was unacceptable, often due to missing an invalid parameter.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"The request was invalid.","documentationUrl":"https://developer.folk.app/api-reference/errors#bad-request","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"aaccc5f2-a3cb-478c-b7d6-a5c11adca40f":{"description":"No valid API key provided.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"No valid API key provided.","documentationUrl":"https://developer.folk.app/api-reference/errors#unauthorized","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"fd904088-9062-496f-b3ae-df8b8fa9c0c3":{"description":"The API key doesn’t have permissions to perform the request.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"The API key doesn’t have permissions to perform the request.","documentationUrl":"https://developer.folk.app/api-reference/errors#forbidden","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a58eb613-4138-46f6-bf5c-5a05cd51b3e3":{"description":"The requested resource doesn’t exist.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RESOURCE_NOT_FOUND","message":"The requested resource was not found.","documentationUrl":"https://developer.folk.app/api-reference/errors#not-found","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"04b0b3c9-af02-4fb1-b77f-d17e9b73f59c":{"description":"A request with the same `Idempotency-Key` is still being processed, or the resource is in a state that does not allow the operation.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":5},"description":"When the conflict resolves on its own, the number of seconds to wait before retrying."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"IDEMPOTENCY_REQUEST_IN_PROGRESS","message":"A request with the same Idempotency-Key is still being processed. Retry once it has completed.","documentationUrl":"https://developer.folk.app/api-reference/idempotency#errors","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"IDEMPOTENCY_REQUEST_IN_PROGRESS","message":"A request with the same Idempotency-Key is still being processed. Retry once it has completed.","documentationUrl":"https://developer.folk.app/api-reference/idempotency#errors","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c1ef6ccb-0f9a-48f6-b93b-b7e5eb69eb47":{"description":"The request was unacceptable, often due to missing or invalid parameters.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNPROCESSABLE_ENTITY","message":"Invalid query parameters","documentationUrl":"https://developer.folk.app/api-reference/errors#unprocessable-entity","details":{"issues":[{"code":"too_small","minimum":1,"type":"number","inclusive":true,"exact":false,"message":"Number must be greater than or equal to 1","path":["limit"]}]},"requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"705d3505-2da3-427d-99ce-4a1cd78eb954":{"description":"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer","example":1000},"description":"The maximum number of requests that you can make in the current rate limit window."},"X-RateLimit-Remaining":{"schema":{"type":"integer","example":998},"description":"The number of requests remaining in the current rate limit window."},"X-RateLimit-Reset":{"schema":{"type":"integer","example":1747322958},"description":"The time at which the current rate limit window resets, in UTC epoch seconds."},"X-RateLimit-Limit-Burst":{"schema":{"type":"integer","example":20},"description":"The maximum number of requests that you can make in the current burst rate limit window."},"X-RateLimit-Remaining-Burst":{"schema":{"type":"integer","example":18},"description":"The number of requests remaining in the current burst rate limit window."},"X-RateLimit-Reset-Burst":{"schema":{"type":"integer","example":1747322902},"description":"The time at which the current burst rate limit window resets, in UTC epoch seconds."},"RateLimit-Policy":{"schema":{"type":"string","example":"\"default\";q=600;w=60, \"burst\";q=20;w=2"},"description":"The rate limit policies applied to the request, as defined by the IETF RateLimit header fields draft. `q` is the number of requests allowed per window and `w` the window length in seconds."},"RateLimit":{"schema":{"type":"string","example":"\"default\";r=598;t=42, \"burst\";r=18;t=1"},"description":"The current usage of each rate limit policy, as defined by the IETF RateLimit header fields draft. `r` is the number of requests remaining and `t` the number of seconds until the window resets."},"Retry-After":{"schema":{"type":"integer","example":60},"description":"The number of seconds to wait before making a new request after hitting the rate limit."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.retryAfter","typeLabel":"string\u003cdate-time>"},"policies":{"type":"array","items":{"type":"object","properties":{"policy":{"type":"string","enum":["default","burst"],"description":"The name of the rate limit policy.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].policy","typeLabel":"enum\u003cstring>"},"limit":{"type":"integer","description":"The maximum number of requests allowed per window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].limit","typeLabel":"integer"},"remaining":{"type":"integer","description":"The number of requests remaining in the current window.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].remaining","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The length of the window, in seconds.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].windowSeconds","typeLabel":"integer"},"retryAfter":{"type":"string","format":"date-time","description":"When the current window resets.","isRequired":true,"uniqueKey":"error.details.policies.items.[INDEX].retryAfter","typeLabel":"string\u003cdate-time>"}},"required":["policy","limit","remaining","windowSeconds","retryAfter"],"uniqueKey":"error.details.policies.items.[INDEX]","typeLabel":"object"},"description":"The status of every rate limit policy applied to the request.","isRequired":true,"uniqueKey":"error.details.policies","typeLabel":"object[]"}},"required":["policy","limit","remaining","windowSeconds","retryAfter","policies"],"description":"The exceeded rate limit policy. When several are exceeded, the one resetting last.","isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response returned when a rate limit is exceeded.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"TOO_MANY_REQUESTS","message":"You have exceeded your rate limit.","documentationUrl":"https://developer.folk.app/api-reference/errors#rate-limiting","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z","details":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z","policies":[{"policy":"default","limit":600,"remaining":412,"windowSeconds":60,"retryAfter":"2025-10-01T12:01:00.000Z"},{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"}]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"05c4b074-55ff-4865-9bfb-c7e3c7db161d":{"description":"Something went wrong on our end.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"An internal server error occurred.","documentationUrl":"https://developer.folk.app/api-reference/errors#internal-server-error","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"70f6104a-3d12-40a5-85f2-4e9b83c61c8c":{"description":"The server is overloaded or down for maintenance.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"TOO_MANY_REQUESTS","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"You have exceeded your rate limit.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","example":"https://developer.folk.app/api-reference/errors#rate-limiting","isRequired":true,"uniqueKey":"error.documentationUrl","typeLabel":"string\u003curi>"},"requestId":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string\u003cuuid>"},"timestamp":{"type":"string","format":"date-time","example":"2025-10-01T12:00:00Z","isRequired":true,"uniqueKey":"error.timestamp","typeLabel":"string\u003cdate-time>"},"details":{"type":"object","additionalProperties":true,"example":{"policy":"burst","limit":20,"remaining":0,"windowSeconds":2,"retryAfter":"2025-10-01T12:00:02.000Z"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message","documentationUrl","requestId","timestamp"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"description":"Error response containing error details.","uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is currently unavailable.","documentationUrl":"https://developer.folk.app/api-reference/errors#service-unavailable","requestId":"123e4567-e89b-12d3-a456-426614174000","timestamp":"2025-10-01T12:00:00Z"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"98204c35-aea2-485d-9b56-d3995e90a084":{"bearerApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"}}},"servers":{"fe19c3b8-6b7d-41af-b676-53250d3345e8":{"url":"https://api.folk.app","description":"Folk's public API production base URL.","x-internal":false}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key for authentication","scopes":[],"schemeName":"bearerApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key for authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerApiKeyAuth","name":"Authorization"}],"title":"bearerApiKeyAuth"}]},"originalFileLocation":"schemas/2025-06-09.json"},"subdomain":"folk-cf968f5e","siteName":"Folk Developer Portal","title":"Update objects in batch - Folk Developer Portal","navMaps":{"firstHrefInVersion":{"2025-06-09":{"href":"/api-reference/custom-objects/update-objects-in-batch","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T15:06:10.129Z","originalFileLocation":"api-reference/custom-objects/update-objects-in-batch.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated. people and companies replace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}. A record whose ID designates an object of another type, or of another group, fails as not found. The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update objects in batch - Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated. people and companies replace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}. A record whose ID designates an object of another type, or of another group, fails as not found. The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://folk-cf968f5e.mintlify.site/_mintlify/api/og/v2?division=Custom+objects\u0026amp;title=Update+objects+in+batch\u0026amp;description=Update+up+to+100+existing+objects+of+one+type+in+a+group%2C+each+with+the+fields+%60PATCH+%2Fv1%2Fgroups%2F%7BgroupId%7D%2F%7BobjectType%7D%2F%7BobjectId%7D%60+accepts.+Each+record+is+upda\u0026amp;theme=85df8d899a1a67ad96f0c424\u0026amp;signature=85f4a0cc217bc2616369bcd01643f04acb7dc419ec380540013692b5dfd1ff34\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update objects in batch - Folk Developer Portal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated. people and companies replace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}. A record whose ID designates an object of another type, or of another group, fails as not found. The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://folk-cf968f5e.mintlify.site/_mintlify/api/og/v2?division=Custom+objects\u0026amp;title=Update+objects+in+batch\u0026amp;description=Update+up+to+100+existing+objects+of+one+type+in+a+group%2C+each+with+the+fields+%60PATCH+%2Fv1%2Fgroups%2F%7BgroupId%7D%2F%7BobjectType%7D%2F%7BobjectId%7D%60+accepts.+Each+record+is+upda\u0026amp;theme=85df8d899a1a67ad96f0c424\u0026amp;signature=85f4a0cc217bc2616369bcd01643f04acb7dc419ec380540013692b5dfd1ff34\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/folk-cf968f5e/2qJ3PKRZLvFhl3LP/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Folk Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/custom-objects/update-objects-in-batch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.folk.app/#organization\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/folk-cf968f5e/I7wFhRmtMuOvy2tG/assets/logo-light.svg?fit=max\u0026auto=format\u0026n=I7wFhRmtMuOvy2tG\u0026q=85\u0026s=08eda1dcbb1eefceac8ca5fea9c103d8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.folk.app#website\",\"name\":\"Folk Developer Portal\",\"url\":\"https://developer.folk.app\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch#webpage\",\"url\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch\",\"name\":\"Update objects in batch\",\"description\":\"Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated. people and companies replace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}. A record whose ID designates an object of another type, or of another group, fails as not found. The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.\",\"dateModified\":\"2026-11-05T15:06:10.129Z\",\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"},\"breadcrumb\":{\"@id\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Available endpoints\",\"item\":\"https://developer.folk.app/api-reference/people/list-people\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Custom objects\",\"item\":\"https://developer.folk.app/api-reference/custom-objects/list-objects\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update objects in batch\",\"item\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch#apireference\",\"headline\":\"Update objects in batch\",\"name\":\"Update objects in batch\",\"description\":\"Update up to 100 existing objects of one type in a group, each with the fields PATCH /v1/groups/{groupId}/{objectType}/{objectId} accepts. Each record is updated on its own: one that fails does not prevent the others from being updated. people and companies replace the people and companies of the object: you must provide the entire list, not just the ones you want to add. Leave them out to keep them unchanged. They are given by ID, and an unknown one, or one not in the group, is ignored, as in PATCH /v1/groups/{groupId}/{objectType}/{objectId}. A record whose ID designates an object of another type, or of another group, fails as not found. The records of one object are merged into one update, in request order: the last value given for a field wins, and customFieldValues are merged field by field, the last value given for a custom field winning. The merged update is validated as a whole: if it is invalid, every record of that object fails with that error. Each of those records gets its own result, with the object as finally updated. An object type that does not exist in the group fails the whole request with a 404, whose message lists the object types of the group.\",\"url\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch\",\"mainEntityOfPage\":{\"@id\":\"https://developer.folk.app/api-reference/custom-objects/update-objects-in-batch#webpage\"},\"dateModified\":\"2026-11-05T15:06:10.129Z\",\"keywords\":\"deal, deals\",\"publisher\":{\"@id\":\"https://developer.folk.app/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.folk.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Folk Developer Portal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Folk Developer Portal","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/quick-start"}]},{"tab":"API Reference","versions":[{"version":"2025-06-09","default":true,"groups":[{"group":"Introduction","pages":[{"title":null,"href":"/api-reference/overview"},{"title":null,"href":"/api-reference/authentication"},{"title":null,"href":"/api-reference/success-responses"},{"title":null,"href":"/api-reference/errors"},{"title":null,"href":"/api-reference/pagination"},{"title":null,"href":"/api-reference/filtering"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Batch requests","href":"/api-reference/batch-requests"},{"title":null,"href":"/api-reference/rate-limits"},{"title":"Request ID","href":"/api-reference/request-id"},{"title":null,"href":"/api-reference/versioning"}]},{"group":"Available endpoints","pages":[{"group":"People","pages":[{"title":"List people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people","href":"/api-reference/people/list-people"},{"openapi":"post /v1/people","title":"Create a person","href":"/api-reference/people/create-a-person"},{"title":"Get a person","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/people/{personId}","href":"/api-reference/people/get-a-person"},{"openapi":"patch /v1/people/{personId}","title":"Update a person","href":"/api-reference/people/update-a-person"},{"openapi":"delete /v1/people/{personId}","title":"Delete a person","href":"/api-reference/people/delete-a-person"},{"openapi":"post /v1/people/batch/create","title":"Create people in batch","href":"/api-reference/people/create-people-in-batch"},{"openapi":"post /v1/people/batch/update","title":"Update people in batch","href":"/api-reference/people/update-people-in-batch"},{"openapi":"post /v1/people/batch/delete","title":"Delete people in batch","href":"/api-reference/people/delete-people-in-batch"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies","href":"/api-reference/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create a company","href":"/api-reference/companies/create-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/companies/{companyId}","href":"/api-reference/companies/get-a-company"},{"openapi":"patch /v1/companies/{companyId}","title":"Update a company","href":"/api-reference/companies/update-a-company"},{"openapi":"delete /v1/companies/{companyId}","title":"Delete a company","href":"/api-reference/companies/delete-a-company"},{"openapi":"post /v1/companies/batch/create","title":"Create companies in batch","href":"/api-reference/companies/create-companies-in-batch"},{"openapi":"post /v1/companies/batch/update","title":"Update companies in batch","href":"/api-reference/companies/update-companies-in-batch"},{"openapi":"post /v1/companies/batch/delete","title":"Delete companies in batch","href":"/api-reference/companies/delete-companies-in-batch"}]},{"group":"Credits","pages":[{"title":"Get credits","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/credits","href":"/api-reference/credits/get-credits"}]},{"group":"Group members","pages":[{"title":"List group members","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/members","href":"/api-reference/group-members/list-group-members"},{"title":"Add a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/members","href":"/api-reference/group-members/add-a-group-member"},{"title":"Update a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/update-a-group-member"},{"title":"Remove a group member","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/groups/{groupId}/members/{userId}","href":"/api-reference/group-members/remove-a-group-member"}]},{"group":"Group custom fields","pages":[{"title":"List group custom fields","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/list-group-custom-fields"},{"title":"Create a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups/{groupId}/custom-fields/{entityType}","href":"/api-reference/group-custom-fields/create-a-group-custom-field"},{"title":"Get a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/get-a-group-custom-field"},{"title":"Update a group custom field","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}/custom-fields/{entityType}/{customFieldName}","href":"/api-reference/group-custom-fields/update-a-group-custom-field"}]},{"group":"Custom objects","pages":[{"openapi":"get /v1/groups/{groupId}/{objectType}","title":"List objects","href":"/api-reference/custom-objects/list-objects"},{"openapi":"post /v1/groups/{groupId}/{objectType}","title":"Create an object","href":"/api-reference/custom-objects/create-an-object"},{"openapi":"get /v1/groups/{groupId}/{objectType}/{objectId}","title":"Get an object","href":"/api-reference/custom-objects/get-an-object"},{"openapi":"patch /v1/groups/{groupId}/{objectType}/{objectId}","title":"Update an object","href":"/api-reference/custom-objects/update-an-object"},{"openapi":"delete /v1/groups/{groupId}/{objectType}/{objectId}","title":"Delete an object","href":"/api-reference/custom-objects/delete-an-object"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/create","title":"Create objects in batch","description":"Create up to 100 new objects of one type in a group, each with the fields `POST /v1/groups/{groupId}/{objectType}` accepts. Each record is created on its own: one that fails does not prevent the others from being created.\n\n**Records are never matched with existing objects.** Two records with the same name, or a record naming an existing object, create separate objects. A batch retried after a timeout or a network error therefore creates every object a second time: send an `Idempotency-Key` header, so that a retry replays the first response instead.\n\n**People and companies are given by ID**, and must already be in the group: an unknown one, or one not in the group, is ignored, as in `POST /v1/groups/{groupId}/{objectType}`. To link people or companies you are importing, create them first, with [Create people in batch](/api-reference/people/create-people-in-batch) or [Create companies in batch](/api-reference/companies/create-companies-in-batch), and use the IDs they return.\n\nThe objects of a request are created together with their people and companies: if that fails, every record fails and no object is created.\n\nAn object type that does not exist in the group fails the whole request with a `404`, whose message lists the object types of the group.","href":"/api-reference/custom-objects/create-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/update","title":"Update objects in batch","href":"/api-reference/custom-objects/update-objects-in-batch"},{"openapi":"post /v1/groups/{groupId}/{objectType}/batch/delete","title":"Delete objects in batch","description":"Delete up to 100 existing objects of one type in a group. Each record is deleted on its own: one that fails does not prevent the others from being deleted.","href":"/api-reference/custom-objects/delete-objects-in-batch"}]},{"group":"Groups","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/groups","href":"/api-reference/groups/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/groups","href":"/api-reference/groups/create-a-group"},{"title":"Update a group","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/groups/{groupId}","href":"/api-reference/groups/update-a-group"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users","href":"/api-reference/users/list-users"},{"title":"Get the current user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/me","href":"/api-reference/users/get-the-current-user"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/users/{userId}","href":"/api-reference/users/get-a-user"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"openapi":"post /v1/notes","title":"Create a note","href":"/api-reference/notes/create-a-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/notes/{noteId}","href":"/api-reference/notes/get-a-note"},{"openapi":"patch /v1/notes/{noteId}","title":"Update a note","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/notes/{noteId}","href":"/api-reference/notes/delete-a-note"}]},{"group":"Reminders","pages":[{"title":"List reminders","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders","href":"/api-reference/reminders/list-reminders"},{"openapi":"post /v1/reminders","deprecated":true,"title":"Create a reminder","href":"/api-reference/reminders/create-a-reminder"},{"title":"Get a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/reminders/{reminderId}","href":"/api-reference/reminders/get-a-reminder"},{"openapi":"patch /v1/reminders/{reminderId}","deprecated":true,"title":"Update a reminder","href":"/api-reference/reminders/update-a-reminder"},{"title":"Delete a reminder","deprecated":true,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/reminders/{reminderId}","href":"/api-reference/reminders/delete-a-reminder"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/tasks/{taskId}","href":"/api-reference/tasks/get-a-task"},{"openapi":"patch /v1/tasks/{taskId}","title":"Update a task","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/tasks/{taskId}","href":"/api-reference/tasks/delete-a-task"},{"title":"Mark a task as done","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-done","href":"/api-reference/tasks/mark-a-task-as-done"},{"title":"Mark a task as to do","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/tasks/{taskId}/mark-as-todo","href":"/api-reference/tasks/mark-a-task-as-to-do"}]},{"group":"Person enrichments","pages":[{"title":"List enrichments of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments","href":"/api-reference/person-enrichments/list-enrichments-of-people"},{"openapi":"post /v1/person-enrichments","title":"Enrich people","href":"/api-reference/person-enrichments/enrich-people"},{"title":"Get an enrichment of people","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/person-enrichments/{enrichmentId}","href":"/api-reference/person-enrichments/get-an-enrichment-of-people"}]},{"group":"Interactions","pages":[{"title":"(Beta) List interactions","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions","href":"/api-reference/interactions/list-interactions"},{"title":"Create an interaction","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/interactions","href":"/api-reference/interactions/create-an-interaction"},{"title":"(Beta) List past interactions","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List past interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/past","href":"/api-reference/interactions/list-past-interactions"},{"title":"(Beta) List upcoming interactions","deprecated":true,"version":null,"tag":"Beta","sidebarTitle":"List upcoming interactions","openapi":"/schemas/2025-06-09.json get /v1/interactions/upcoming","href":"/api-reference/interactions/list-upcoming-interactions"},{"title":"(Beta) Get a past or upcoming interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a past or upcoming interaction","openapi":"/schemas/2025-06-09.json get /v1/interactions/{interactionId}","href":"/api-reference/interactions/get-a-past-or-upcoming-interaction"},{"title":"(Beta) Update an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update an interaction","openapi":"/schemas/2025-06-09.json patch /v1/interactions/{interactionId}","href":"/api-reference/interactions/update-an-interaction"},{"title":"(Beta) Delete an interaction","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete an interaction","openapi":"/schemas/2025-06-09.json delete /v1/interactions/{interactionId}","href":"/api-reference/interactions/delete-an-interaction"}]},{"group":"Webhooks","pages":[{"openapi":"get /v1/webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"post /v1/webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"patch /v1/webhooks/{webhookId}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Campaigns","pages":[{"title":"(Beta) List campaigns","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List campaigns","openapi":"/schemas/2025-06-09.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"(Beta) Create a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Create a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns","href":"/api-reference/campaigns/create-a-campaign"},{"title":"(Beta) Get a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-a-campaign"},{"title":"(Beta) Update a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-a-campaign"},{"title":"(Beta) Delete a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Delete a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/delete-a-campaign"},{"title":"(Beta) List the messages of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the messages of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages","href":"/api-reference/campaigns/list-the-messages-of-a-campaign"},{"title":"(Beta) Get a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Get a message of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/get-a-message-of-a-campaign"},{"title":"(Beta) Update a message of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update a message of a campaign","openapi":"/schemas/2025-06-09.json patch /v1/campaigns/{campaignId}/messages/{messageId}","href":"/api-reference/campaigns/update-a-message-of-a-campaign"},{"title":"(Beta) List the variables of a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List the variables of a campaign","openapi":"/schemas/2025-06-09.json get /v1/campaigns/{campaignId}/variables","href":"/api-reference/campaigns/list-the-variables-of-a-campaign"},{"title":"(Beta) Stop a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Stop a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/stop","href":"/api-reference/campaigns/stop-a-campaign"},{"title":"(Beta) Review a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Review a campaign","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/review","href":"/api-reference/campaigns/review-a-campaign"},{"title":"(Beta) Put a campaign back to draft","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Put a campaign back to draft","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/draft","href":"/api-reference/campaigns/put-a-campaign-back-to-draft"},{"title":"(Beta) Update messages of a campaign in batch","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Update messages of a campaign in batch","openapi":"/schemas/2025-06-09.json post /v1/campaigns/{campaignId}/messages/batch/update","href":"/api-reference/campaigns/update-messages-of-a-campaign-in-batch"},{"title":"(Beta) Remove a recipient from a campaign","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"Remove a recipient from a campaign","openapi":"/schemas/2025-06-09.json delete /v1/campaigns/{campaignId}/recipients/{contactId}","href":"/api-reference/campaigns/remove-a-recipient-from-a-campaign"},{"title":"(Beta) List message senders","deprecated":null,"version":null,"tag":"Beta","sidebarTitle":"List message senders","openapi":"/schemas/2025-06-09.json get /v1/message-senders","href":"/api-reference/campaigns/list-message-senders"}]},{"group":"Views","pages":[{"title":"List views","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/views","href":"/api-reference/views/list-views"},{"title":"Create a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json post /v1/views","href":"/api-reference/views/create-a-view"},{"title":"Get a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json get /v1/views/{viewId}","href":"/api-reference/views/get-a-view"},{"title":"Update a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json patch /v1/views/{viewId}","href":"/api-reference/views/update-a-view"},{"title":"Delete a view","deprecated":null,"version":null,"openapi":"/schemas/2025-06-09.json delete /v1/views/{viewId}","href":"/api-reference/views/delete-a-view"}]}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Roadmap","pages":[{"title":"Roadmap","href":"/roadmap"}]}]},"basePath":"","title":"Update objects in batch - Folk Developer Portal","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","Page-D9ithiIZ.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}