Creates a new job, which runs asynchronously and returns a job ID. The job ID can be used to check the status of the job.The job contains an array of operations, of the same format as the single changes APIs:
Add - Invites a new member to your Onsi programme.
Replace - Replaces the member’s data with new information. An inactive member will be re-added to Onsi.
Update - Updates the member’s data with new information. Does not re-add inactive members.
Remove - Removes the member from your Onsi programme.
If there are issues with any of the operations, the API will return a 400 status code with the following error codes:
If there are issues, Onsi will not process any of the operations in your request, and will not create a job. You will
need to fix the issues and send a subsequent request.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Onsi API","description":"The Onsi API is a RESTful API that allows you to manage your Onsi platform","colors":{"primary":"#7E78FF","light":"#BFF403","dark":"#7E78FF"},"logo":{"light":"https://mintcdn.com/onsi/vAIKXR0XHSZi65ty/logo/light.svg?fit=max\u0026auto=format\u0026n=vAIKXR0XHSZi65ty\u0026q=85\u0026s=f8db2ccf3f86be3b9453134971d6aaf6","dark":"https://mintcdn.com/onsi/vAIKXR0XHSZi65ty/logo/dark.svg?fit=max\u0026auto=format\u0026n=vAIKXR0XHSZi65ty\u0026q=85\u0026s=0276d0ae02facd847d96a506e4c7dfb4"},"favicon":"https://mintcdn.com/onsi/HfG0qaPraniXeOUH/favicon.png?fit=max\u0026auto=format\u0026n=HfG0qaPraniXeOUH\u0026q=85\u0026s=6956e108230ec270890e5bab61eeb9ed","background":{"color":{"light":"#FFFFFF","dark":"#080808"}},"navbar":{"links":[{"href":"mailto:api@onsi.com","label":"Support"}],"primary":{"type":"button","label":"Partner Platform","href":"https://partners.onsi.com"}},"footer":{},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onsi","hasAudioNarration":false,"actualSubdomain":"onsi","customDomains":["docs.onsi.com"],"gitSource":{"type":"github","owner":"collectiveuk","repo":"collective-application","deployBranch":"master","contentDirectory":"apps/web-api-docs/src","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e62591916e8ce404e7e1","collectionId":"6bd45a4e-1ee0-475f-80c8-d12a0fef4659","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae91f513378bc4b782a2897:success","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Documentation","count":14},{"language":"default","tag":"On Demand Pay","count":11},{"language":"default","tag":"Members","count":10},{"language":"default","tag":"Schemas","count":6},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Single Member Actions","count":5},{"language":"default","tag":"Embedded Pay","count":4},{"language":"default","tag":"Full Member List CSV","count":2},{"language":"default","tag":"Batch Member Actions","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/jobs/batch-job","slug":"/api-reference/jobs/batch-job","pageMetadata":{"title":"Create Batch Job","openapi":"POST /v1/members/jobs","description":null,"href":"/api-reference/jobs/batch-job"},"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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Creates a new job, which runs asynchronously and returns a job ID. The job ID can be used to check the status of the job.`}),`\n`,_jsx(_components.p,{children:`The job contains an array of operations, of the same format as the single changes APIs:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Add`}),` - Invites a new member to your Onsi programme.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Replace`}),` - Replaces the member’s data with new information. An inactive member `,_jsx(_components.strong,{children:`will be`}),` re-added to Onsi.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Update`}),` - Updates the member’s data with new information. Does `,_jsx(_components.strong,{children:`not`}),` re-add inactive members.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Remove`}),` - Removes the member from your Onsi programme.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`4`,id:`unsetting-bank-details`,children:`Unsetting Bank Details`}),`\n`,_jsxs(_components.p,{children:[`For `,_jsx(_components.strong,{children:`Replace`}),` and `,_jsx(_components.strong,{children:`Update`}),` operations, you can remove a member’s bank details by setting `,_jsx(_components.code,{children:`accountDetails`}),` to `,_jsx(_components.code,{children:`null`}),`.`]}),`\n`,_jsx(Heading,{level:`4`,id:`relevant-error-codes`,children:`Relevant Error Codes`}),`\n`,_jsxs(_components.p,{children:[`If there are issues with any of the operations, the API will return a `,_jsx(_components.code,{children:`400`}),` status code with the following error codes:`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`If there are issues, Onsi will not process any of the operations in your request, and will not create a job. You will\nneed to fix the issues and send a subsequent request.`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/error-handling#invalidaddmemberpayload`,children:`InvalidAddMemberPayload`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/error-handling#invalidupdatememberpayload`,children:`InvalidUpdateMemberPayload`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/api-reference/error-handling#invalidremovememberpayload`,children:`InvalidRemoveMemberPayload`})}),`\n`]})]})}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":{"title":"Create Batch Job","openapi":"POST /v1/members/jobs","description":null,"href":"/api-reference/jobs/batch-job"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Unsetting Bank Details","slug":"unsetting-bank-details","depth":4,"children":[]},{"title":"Relevant Error Codes","slug":"relevant-error-codes","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["members"],"parameters":["796851ba-ce15-46aa-aeb2-1ccb78b287a7"],"operationId":"createJob","requestBody":"6f747197-0e95-4579-9ac8-e4915443bc7d","responses":{"202":"b77bf22f-1dfb-4644-9a9c-ab81269b0a5e"},"method":"post","type":"path","servers":["f90fee75-7711-4817-b638-652560765545","e35408b6-d01f-4b82-94b5-75315cf20782"],"security":["ad80283b-965b-4b5b-9cbe-1bd7ce485bd0"],"path":"/v1/members/jobs","baseUrlOptions":["https://api.onsi.com","https://api.onsi.dev"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"796851ba-ce15-46aa-aeb2-1ccb78b287a7":{"name":"x-idempotency-key","in":"header","description":"Unique key to ensure idempotency of the request","schema":{"type":"string","description":"Unique key to ensure idempotency of the request","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"description":"Body","content":{"application/json":{"schema":{"type":"object","properties":{"actions":{"minItems":1,"type":"array","items":{"oneOf":[{"type":"object","title":"Add","description":"Add a new member","required":["email","firstName","lastName","tier","type"],"properties":{"email":{"example":"jane-smith@onsi.com","description":"A unique email address for the member","type":"string","format":"email","pattern":"^(([^\u003c>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^\u003c>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.email","typeLabel":"string\u003cemail>"},"firstName":{"example":"John","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.firstName","typeLabel":"string"},"lastName":{"example":"Smith","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.lastName","typeLabel":"string"},"tier":{"example":"Gold","description":"Tier name for the member","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.tier","typeLabel":"string"},"type":{"type":"string","enum":["Add"],"isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"phone":{"example":"+447123456789","description":"An optional phone number for the member","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.0.phone","typeLabel":"string"},"workerId":{"example":"ID_123","description":"Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.0.workerId","typeLabel":"string"},"accountDetails":{"oneOf":[{"type":"object","title":"BankAccountUK","description":"A UK bank account","required":["accountHolder","sortCode","accountNumber"],"example":{"accountHolder":"John Smith","sortCode":"123456","accountNumber":"12345678"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.0.accountHolder","typeLabel":"string"},"sortCode":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.0.sortCode","typeLabel":"string"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.0.accountNumber","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.0","typeLabel":"BankAccountUK · object"},{"type":"object","title":"BankAccountEU","description":"A EU bank account","required":["accountHolder","iban"],"example":{"accountHolder":"John Smith","iban":"GB29NWBK60161331926819"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.1.accountHolder","typeLabel":"string"},"iban":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.1.iban","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.1","typeLabel":"BankAccountEU · object"},{"type":"null","uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails.oneOf.2","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.0.accountDetails","typeLabel":"BankAccountUK · object | BankAccountEU · object | null"},"enablePayroll":{"type":"boolean","uniqueKey":"actions.items.[INDEX].oneOf.0.enablePayroll","typeLabel":"boolean"},"dob":{"example":"1990-01-01","description":"Date of birth of the member, must later than 1900","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"actions.items.[INDEX].oneOf.0.dob","typeLabel":"string"},"gender":{"oneOf":[{"type":"string","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.0.gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.0.gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.0.gender","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.0","typeLabel":"Add · object"},{"type":"object","title":"Replace","description":"Replace an existing member","required":["email","firstName","lastName","tier","type","memberId"],"properties":{"email":{"example":"jane-smith@onsi.com","description":"A unique email address for the member","type":"string","format":"email","pattern":"^(([^\u003c>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^\u003c>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.email","typeLabel":"string\u003cemail>"},"firstName":{"example":"John","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.firstName","typeLabel":"string"},"lastName":{"example":"Smith","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.lastName","typeLabel":"string"},"tier":{"example":"Gold","description":"Tier name for the member","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.tier","typeLabel":"string"},"type":{"type":"string","enum":["Replace"],"isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"memberId":{"example":"mem_\u003cid>","description":"The unique identifier for a Member, prefixed with mem_","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.memberId","typeLabel":"string"},"phone":{"example":"+447123456789","description":"An optional phone number for the member","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.1.phone","typeLabel":"string"},"workerId":{"example":"ID_123","description":"Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.1.workerId","typeLabel":"string"},"accountDetails":{"oneOf":[{"type":"object","title":"BankAccountUK","description":"A UK bank account","required":["accountHolder","sortCode","accountNumber"],"example":{"accountHolder":"John Smith","sortCode":"123456","accountNumber":"12345678"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.0.accountHolder","typeLabel":"string"},"sortCode":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.0.sortCode","typeLabel":"string"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.0.accountNumber","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.0","typeLabel":"BankAccountUK · object"},{"type":"object","title":"BankAccountEU","description":"A EU bank account","required":["accountHolder","iban"],"example":{"accountHolder":"John Smith","iban":"GB29NWBK60161331926819"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.1.accountHolder","typeLabel":"string"},"iban":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.1.iban","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.1","typeLabel":"BankAccountEU · object"},{"type":"null","uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails.oneOf.2","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.1.accountDetails","typeLabel":"BankAccountUK · object | BankAccountEU · object | null"},"enablePayroll":{"type":"boolean","uniqueKey":"actions.items.[INDEX].oneOf.1.enablePayroll","typeLabel":"boolean"},"dob":{"example":"1990-01-01","description":"Date of birth of the member, must later than 1900","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"actions.items.[INDEX].oneOf.1.dob","typeLabel":"string"},"gender":{"oneOf":[{"type":"string","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.1.gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.1.gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.1.gender","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.1","typeLabel":"Replace · object"},{"type":"object","title":"Update","description":"Update an existing member","required":["type","memberId"],"properties":{"type":{"type":"string","enum":["Update"],"isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"memberId":{"example":"mem_\u003cid>","description":"The unique identifier for a Member, prefixed with mem_","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.memberId","typeLabel":"string"},"email":{"description":"This can only be changed if member status is `invited`","type":"string","format":"email","pattern":"^(([^\u003c>()\\[\\]\\\\.,;:\\s@\"]+(\\.[^\u003c>()\\[\\]\\\\.,;:\\s@\"]+)*)|(\".+\"))@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}])|(([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}))$","uniqueKey":"actions.items.[INDEX].oneOf.2.email","typeLabel":"string\u003cemail>"},"firstName":{"description":"First name of the member","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.2.firstName","typeLabel":"string"},"lastName":{"description":"Last name of the member","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.2.lastName","typeLabel":"string"},"phone":{"description":"Phone number","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.2.phone","typeLabel":"string"},"workerId":{"oneOf":[{"type":"string","description":"Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)","example":"ID_123","uniqueKey":"actions.items.[INDEX].oneOf.2.workerId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique ID provided by API consumer, must be unique across all members (active, invited and inactive)","example":"ID_123","uniqueKey":"actions.items.[INDEX].oneOf.2.workerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.2.workerId","typeLabel":"string | null"},"tier":{"description":"Tier name","type":"string","uniqueKey":"actions.items.[INDEX].oneOf.2.tier","typeLabel":"string"},"accountDetails":{"oneOf":[{"type":"object","title":"BankAccountUK","description":"A UK bank account","required":["accountHolder","sortCode","accountNumber"],"example":{"accountHolder":"John Smith","sortCode":"123456","accountNumber":"12345678"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.0.accountHolder","typeLabel":"string"},"sortCode":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.0.sortCode","typeLabel":"string"},"accountNumber":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.0.accountNumber","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.0","typeLabel":"BankAccountUK · object"},{"type":"object","title":"BankAccountEU","description":"A EU bank account","required":["accountHolder","iban"],"example":{"accountHolder":"John Smith","iban":"GB29NWBK60161331926819"},"properties":{"accountHolder":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.1.accountHolder","typeLabel":"string"},"iban":{"type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.1.iban","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.1","typeLabel":"BankAccountEU · object"},{"type":"null","uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails.oneOf.2","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.2.accountDetails","typeLabel":"BankAccountUK · object | BankAccountEU · object | null"},"enablePayroll":{"type":"boolean","uniqueKey":"actions.items.[INDEX].oneOf.2.enablePayroll","typeLabel":"boolean"},"dob":{"example":"1990-01-01","description":"Date of birth of the member, must later than 1900","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","uniqueKey":"actions.items.[INDEX].oneOf.2.dob","typeLabel":"string"},"gender":{"oneOf":[{"type":"string","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.2.gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Gender of the member","enum":["Female","Male","NonBinary"],"uniqueKey":"actions.items.[INDEX].oneOf.2.gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.items.[INDEX].oneOf.2.gender","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.2","typeLabel":"Update · object"},{"type":"object","title":"Offboard","description":"Offboard a member","required":["type","memberId"],"properties":{"type":{"type":"string","enum":["Offboard"],"isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"memberId":{"example":"mem_\u003cid>","description":"The unique identifier for a Member, prefixed with mem_","type":"string","isRequired":true,"uniqueKey":"actions.items.[INDEX].oneOf.3.memberId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"actions.items.[INDEX].oneOf.3","typeLabel":"Offboard · object"}],"uniqueKey":"actions.items.[INDEX]","typeLabel":"Add · object | Replace · object | Update · object | Offboard · object"},"isRequired":true,"uniqueKey":"actions","typeLabel":"(Add · object | Replace · object | Update · object | Offboard · object)[]"}},"required":["actions"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"actions":[{"email":"jane-smith@onsi.com","firstName":"John","lastName":"Smith","tier":"Gold","type":"Add","phone":"+447123456789","workerId":"ID_123","accountDetails":{"accountHolder":"John Smith","sortCode":"123456","accountNumber":"12345678"},"enablePayroll":true,"dob":"1990-01-01"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b77bf22f-1dfb-4644-9a9c-ab81269b0a5e":{"description":"202","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"example":"maj_cltd2zp7100096tmbamb9c46o","type":"string","isRequired":true,"uniqueKey":"jobId","typeLabel":"string"}},"required":["jobId"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"jobId":"maj_cltd2zp7100096tmbamb9c46o"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ad80283b-965b-4b5b-9cbe-1bd7ce485bd0":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]}}},"servers":{"f90fee75-7711-4817-b638-652560765545":{"url":"https://api.onsi.com","description":"Production"},"e35408b6-d01f-4b82-94b5-75315cf20782":{"url":"https://api.onsi.dev","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[]},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"onsi","siteName":"Onsi API","title":"Create Batch Job - Onsi API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-05T11:16:00.902Z","originalFileLocation":"api-reference/jobs/batch-job.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=\"application-name\" content=\"Onsi API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_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/onsi/77pskcVugXYX_tAJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Batch Job - Onsi API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Onsi API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onsi.com/api-reference/jobs/batch-job\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onsi.mintlify.app/_mintlify/api/og/v2?division=Batch+Member+Actions\u0026amp;title=Create+Batch+Job\u0026amp;theme=5e0a14837836e2857c842a8a\u0026amp;signature=6c8ce0fb7b3c3a250db095b97605f17d830d5ee9771950125ac13191a1d2b8d0\">\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=\"Create Batch Job - Onsi API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onsi.mintlify.app/_mintlify/api/og/v2?division=Batch+Member+Actions\u0026amp;title=Create+Batch+Job\u0026amp;theme=5e0a14837836e2857c842a8a\u0026amp;signature=6c8ce0fb7b3c3a250db095b97605f17d830d5ee9771950125ac13191a1d2b8d0\">\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/onsi/77pskcVugXYX_tAJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Onsi API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7E78FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onsi.com/api-reference/jobs/batch-job\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/jobs/batch-job.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onsi.com/#organization\",\"name\":\"Onsi API\",\"url\":\"https://docs.onsi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onsi/vAIKXR0XHSZi65ty/logo/light.svg?fit=max\u0026auto=format\u0026n=vAIKXR0XHSZi65ty\u0026q=85\u0026s=f8db2ccf3f86be3b9453134971d6aaf6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onsi.com#website\",\"name\":\"Onsi API\",\"url\":\"https://docs.onsi.com\",\"publisher\":{\"@id\":\"https://docs.onsi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onsi.com/api-reference/jobs/batch-job#webpage\",\"url\":\"https://docs.onsi.com/api-reference/jobs/batch-job\",\"name\":\"Create Batch Job\",\"dateModified\":\"2026-05-05T11:16:00.902Z\",\"isPartOf\":{\"@id\":\"https://docs.onsi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onsi.com/api-reference/jobs/batch-job#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onsi.com/api-reference/jobs/batch-job#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Members\",\"item\":\"https://docs.onsi.com/api-reference/members/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Batch Job\",\"item\":\"https://docs.onsi.com/api-reference/jobs/batch-job\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onsi.com/api-reference/jobs/batch-job#apireference\",\"headline\":\"Create Batch Job\",\"name\":\"Create Batch Job\",\"url\":\"https://docs.onsi.com/api-reference/jobs/batch-job\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onsi.com/api-reference/jobs/batch-job#webpage\"},\"dateModified\":\"2026-05-05T11:16:00.902Z\",\"publisher\":{\"@id\":\"https://docs.onsi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onsi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Onsi API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Onsi API","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/api-reference/introduction"}]},{"anchor":"API Reference","icon":"square-terminal","pages":[{"group":"Members","pages":[{"group":"Single Member Actions","pages":[{"title":"Get Member","openapi":"GET /v1/members/{id}","href":"/api-reference/members/get"},{"title":"Invite Member","openapi":"POST /v1/members","href":"/api-reference/members/post"},{"title":"Update Member","openapi":"PATCH /v1/members/{id}","href":"/api-reference/members/patch"},{"title":"Replace Member","openapi":"PUT /v1/members/{id}","href":"/api-reference/members/put"},{"title":"Remove Member","openapi":"DELETE /v1/members/{id}","description":null,"href":"/api-reference/members/delete"}]},{"group":"Batch Member Actions","pages":[{"title":"Create Batch Job","openapi":"POST /v1/members/jobs","href":"/api-reference/jobs/batch-job"}]},{"group":"Full Member List CSV","pages":[{"title":"Upload Full Member List CSV","openapi":"PUT /v1/members/jobs/csv","description":null,"href":"/api-reference/jobs/csv"},{"title":"Upload Full Member List CSV V2","openapi":"PUT /v2/members/jobs/csv","href":"/api-reference/jobs/csv-v2"}]},{"title":"Search Members","openapi":"GET /v1/members","href":"/api-reference/members/search"},{"title":"Get Job","openapi":"GET /v1/members/jobs/{jobId}","href":"/api-reference/jobs/get-job"}]},{"group":"Tiering","pages":[{"title":"Get Tiers","openapi":"GET /v1/tiers","href":"/api-reference/members/get-tiers"}]},{"group":"On Demand Pay","pages":[{"title":"Create Pay Run","openapi":"POST /v1/pay/run","href":"/api-reference/pay/upload-pay"},{"title":"Get Cycles","openapi":"GET /v1/pay/cycles","href":"/api-reference/pay/get-cycles"},{"title":"Get Cycle","openapi":"GET /v1/pay/cycles/{id}","href":"/api-reference/pay/get-cycle"},{"title":"Get Cycle Deductions","openapi":"GET /v1/pay/cycles/{id}/deductions","href":"/api-reference/pay/get-cycle-deductions"},{"group":"Embedded Pay","pages":[{"title":"Create Withdrawal Intent","openapi":"POST /v1/pay/withdrawals/intent","href":"/api-reference/pay/create-withdrawal-intent"},{"title":"Complete Withdrawal","openapi":"POST /v1/pay/withdrawals/complete","href":"/api-reference/pay/complete-withdrawal"},{"title":"Get Member Balance","openapi":"GET /v1/pay/members/{memberId}/balance","href":"/api-reference/pay/get-member-balance"},{"title":"Get Withdrawals","openapi":"GET /v1/pay/withdrawals","href":"/api-reference/pay/get-withdrawals"}]},{"group":"Deprecated","pages":[{"title":"Get Member Withdrawals","openapi":"GET /v1/pay/members/{memberId}/withdrawals","deprecated":true,"href":"/api-reference/pay/get-member-withdrawals"}]}]}]}]},"basePath":"","title":"Create Batch Job - Onsi API","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}