Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Swipe","colors":{"primary":"#2045D1","light":"#538DFF","dark":"#2045D1"},"logo":{"light":"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_light.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=44d5e4b626518cb3542e8ef16e85f182","dark":"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_dark.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=84cf20e2bc4f85a8fea2938d2f43412e","href":"/"},"favicon":"https://mintcdn.com/swipe/ZOyvFX50eH4DT_Wr/favicon.svg?fit=max\u0026auto=format\u0026n=ZOyvFX50eH4DT_Wr\u0026q=85\u0026s=9f4476cef1667d0c527f72dd6036726b","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://app.getswipe.in/user?tab=api_integration","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.getswipe.in"}},"footer":{"socials":{"x":"https://twitter.com/swipebilling","instagram":"https://www.instagram.com/swipebilling","linkedin":"https://www.linkedin.com/company/swipebilling"}},"search":{"prompt":"Search the Swipe API docs..."},"seo":{"metatags":{"og:site_name":"Swipe API Documentation","og:type":"website"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Run in Postman","icon":{"style":"thin","name":"user-astronaut"},"href":"https://god.gw.postman.com/run-collection/43895811-b7327b9d-1e50-4fed-af6f-660a918aa817?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D43895811-b7327b9d-1e50-4fed-af6f-660a918aa817%26entityType%3Dcollection%26workspaceId%3D5d3fc3f0-668c-499e-833b-03222666ba2a"},{"anchor":"Blog","icon":"newspaper","href":"https://getswipe.in/blog"},{"anchor":"Community","icon":"slack","href":"https://community.getswipe.in/c/api-integration/14"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"swipe","hasAudioNarration":false,"actualSubdomain":"swipe","customDomains":["developers.getswipe.in"],"gitSource":{"type":"github","owner":"swipe-yc21","repo":"partner-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aa158f50379420e6579534a","collectionId":"9e7e6d91-a01b-44eb-b79d-efe99a4644f3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aa158f50379420e6579534a"},"entitlements":{},"buildId":"6aa158f50379420e6579534a","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Documentation","count":74},{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"Customers","count":7},{"language":"default","tag":"Customer","count":7},{"language":"default","tag":"Vendors","count":7},{"language":"default","tag":"Documents","count":6},{"language":"default","tag":"Products","count":6},{"language":"default","tag":"Product","count":6},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Resources","count":4}]},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customer/update-a-customer","slug":"/api-reference/customer/update-a-customer","pageMetadata":{"openapi":"put /v1/customer","title":"Update a customer","description":"**v1 is deprecated — use the v2 endpoint instead.** Updates an existing customer's details. Changes propagate to the documents linked to this customer.","href":"/api-reference/customer/update-a-customer"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"v1 is deprecated — use the v2 endpoint instead.\"\n }), \" Updates an existing customer’s details. Changes propagate to the documents linked to this customer.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"put /v1/customer","title":"Update a customer","description":"**v1 is deprecated — use the v2 endpoint instead.** Updates an existing customer's details. Changes propagate to the documents linked to this customer.","href":"/api-reference/customer/update-a-customer"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update a customer","operationId":"put_customer","tags":["Customer"],"requestBody":"9c16b453-5f16-4b95-b2c2-8f9b9c269f9a","responses":{"200":"8b3a2d8a-da39-4275-965e-af7dd0366f20","400":"b2b790fd-ef1e-4c56-af1b-ae8241da9f54","401":"9c3ebd91-7e70-4226-80ba-4c10cfc4b75a"},"description":"**v1 is deprecated — use the v2 endpoint instead.** Updates an existing customer's details. Changes propagate to the documents linked to this customer.","method":"put","type":"path","servers":["82b38fec-7303-4b6e-86bb-63d990b1e4ef"],"security":["13576f02-530d-4f08-aab7-91987ee153ab"],"path":"/v1/customer","baseUrlOptions":["https://app.getswipe.in/api/partner"],"title":"Update a customer","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"required":["customer_id","name"],"properties":{"customer_id":{"type":"string","description":"Your Customer ID","example":"123","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"name":{"type":"string","description":"Customer name","example":"TATA RATAN","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"phone":{"type":"string","description":"Phone number","example":1234567890,"uniqueKey":"phone","typeLabel":"string"},"email":{"type":"string","description":"Email address","example":"reddi@reddi.reddi","uniqueKey":"email","typeLabel":"string"},"discount":{"type":"integer","description":"Discount","example":10,"uniqueKey":"discount","typeLabel":"integer"},"gstin":{"type":"string","description":"GSTIN","example":"27AARCS7202C1ZD","pattern":"^(|[0-9A-Z]{15})$","uniqueKey":"gstin","typeLabel":"string"},"company_name":{"type":"string","description":"Company name","example":"GSTN","uniqueKey":"company_name","typeLabel":"string"},"opening_balance":{"type":"string","description":"Opening balance","example":"1245","uniqueKey":"opening_balance","typeLabel":"string"},"credit_limit":{"type":"integer","description":"Credit limit","example":200,"uniqueKey":"credit_limit","typeLabel":"integer"},"billing_address":{"type":"array","description":"List of billing addresses","items":{"required":["state"],"properties":{"state":{"type":"string","description":"State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details","example":"State Name","enum":["JAMMU AND KASHMIR","HIMACHAL PRADESH","PUNJAB","CHANDIGARH","UTTARAKHAND","HARYANA","DELHI","RAJASTHAN","UTTAR PRADESH","BIHAR","SIKKIM","ARUNACHAL PRADESH","NAGALAND","MANIPUR","MIZORAM","TRIPURA","MEGHALAYA","ASSAM","WEST BENGAL","JHARKHAND","ODISHA","CHHATTISGARH","MADHYA PRADESH","GUJARAT","DADRA \u0026 NAGAR HAVELI \u0026 DAMAN \u0026 DIU","MAHARASHTRA","ANDHRAPRADESH(BEFOREADDED)","KARNATAKA","GOA","LAKSHWADEEP","KERALA","TAMIL NADU","PUDUCHERRY","ANDAMAN \u0026 NICOBAR","TELANGANA","ANDHRA PRADESH","LADAKH(NEWLYADDED)","LADAKH(NEWLY ADDED)","OTHER TERRITORY"],"isRequired":true,"uniqueKey":"billing_address.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"address_line1":{"type":"string","description":"Address line 1","example":"","uniqueKey":"billing_address.items.[INDEX].address_line1","typeLabel":"string"},"address_line2":{"type":"string","description":"Address line 2","example":"","uniqueKey":"billing_address.items.[INDEX].address_line2","typeLabel":"string"},"pincode":{"type":"string","description":"Pincode","example":"500075","uniqueKey":"billing_address.items.[INDEX].pincode","typeLabel":"string"},"city":{"type":"string","description":"City","example":"","uniqueKey":"billing_address.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","description":"Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array","example":"India","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","Antigua and Barbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","Bosnia and Herzegovina","Botswana","Brazil","Brunei","Bulgaria","Burkina Faso","Burundi","Cabo Verde","Cambodia","Cameroon","Canada","Central African Republic","Chad","Chile","China","Colombia","Comoros","Congo, Democratic Republic of the","Congo, Republic of the","Costa Rica","Croatia","Cuba","Cyprus","Czechia","Denmark","Djibouti","Dominica","Dominican Republic","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Eswatini","Ethiopia","Fiji","Finland","France","Gabon","Gambia","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","Guinea-Bissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","Republic of Korea (South Korea)","Kosovo","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Mauritania","Mauritius","Mexico","Micronesia","Moldova","Monaco","Mongolia","Montenegro","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","New Zealand","Nicaragua","Niger","Nigeria","North Macedonia","Norway","Oman","Pakistan","Palau","Palestine","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","Saint Kitts and Nevis","Saint Lucia","Saint Vincent and the Grenadines","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Serbia","Seychelles","Sierra Leone","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Sudan","Spain","Sri Lanka","Sudan","Suriname","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Timor-Leste","Togo","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","Uruguay","Uzbekistan","Vanuatu","Vatican City","Venezuela","Vietnam","Yemen","Zambia","Zimbabwe"],"uniqueKey":"billing_address.items.[INDEX].country","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"billing_address.items.[INDEX]","typeLabel":"object"},"uniqueKey":"billing_address","typeLabel":"object[]"},"shipping_address":{"type":"array","description":"List of shipping addresses","items":{"required":["state"],"properties":{"state":{"type":"string","description":"State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details","example":"State Name","enum":["JAMMU AND KASHMIR","HIMACHAL PRADESH","PUNJAB","CHANDIGARH","UTTARAKHAND","HARYANA","DELHI","RAJASTHAN","UTTAR PRADESH","BIHAR","SIKKIM","ARUNACHAL PRADESH","NAGALAND","MANIPUR","MIZORAM","TRIPURA","MEGHALAYA","ASSAM","WEST BENGAL","JHARKHAND","ODISHA","CHHATTISGARH","MADHYA PRADESH","GUJARAT","DADRA \u0026 NAGAR HAVELI \u0026 DAMAN \u0026 DIU","MAHARASHTRA","ANDHRAPRADESH(BEFOREADDED)","KARNATAKA","GOA","LAKSHWADEEP","KERALA","TAMIL NADU","PUDUCHERRY","ANDAMAN \u0026 NICOBAR","TELANGANA","ANDHRA PRADESH","LADAKH(NEWLYADDED)","LADAKH(NEWLY ADDED)","OTHER TERRITORY"],"isRequired":true,"uniqueKey":"shipping_address.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"address_line1":{"type":"string","description":"Address line 1","example":"","uniqueKey":"shipping_address.items.[INDEX].address_line1","typeLabel":"string"},"address_line2":{"type":"string","description":"Address line 2","example":"","uniqueKey":"shipping_address.items.[INDEX].address_line2","typeLabel":"string"},"pincode":{"type":"string","description":"Pincode","example":"500075","uniqueKey":"shipping_address.items.[INDEX].pincode","typeLabel":"string"},"city":{"type":"string","description":"City","example":"","uniqueKey":"shipping_address.items.[INDEX].city","typeLabel":"string"},"country":{"type":"string","description":"Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array","example":"India","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","Antigua and Barbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","Bosnia and Herzegovina","Botswana","Brazil","Brunei","Bulgaria","Burkina Faso","Burundi","Cabo Verde","Cambodia","Cameroon","Canada","Central African Republic","Chad","Chile","China","Colombia","Comoros","Congo, Democratic Republic of the","Congo, Republic of the","Costa Rica","Croatia","Cuba","Cyprus","Czechia","Denmark","Djibouti","Dominica","Dominican Republic","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Eswatini","Ethiopia","Fiji","Finland","France","Gabon","Gambia","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","Guinea-Bissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","Republic of Korea (South Korea)","Kosovo","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Mauritania","Mauritius","Mexico","Micronesia","Moldova","Monaco","Mongolia","Montenegro","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","New Zealand","Nicaragua","Niger","Nigeria","North Macedonia","Norway","Oman","Pakistan","Palau","Palestine","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","Saint Kitts and Nevis","Saint Lucia","Saint Vincent and the Grenadines","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Serbia","Seychelles","Sierra Leone","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Sudan","Spain","Sri Lanka","Sudan","Suriname","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Timor-Leste","Togo","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","Uruguay","Uzbekistan","Vanuatu","Vatican City","Venezuela","Vietnam","Yemen","Zambia","Zimbabwe"],"uniqueKey":"shipping_address.items.[INDEX].country","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"shipping_address.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shipping_address","typeLabel":"object[]"},"opening_balance_type":{"type":"integer","description":"Credit[0] / Debit[1]","example":1,"uniqueKey":"opening_balance_type","typeLabel":"integer"},"dial_code":{"type":"string","description":"Dial code","example":"91","uniqueKey":"dial_code","typeLabel":"string"},"profile_image":{"type":"string","description":"Profile image URL","example":"","uniqueKey":"profile_image","typeLabel":"string"},"pan":{"type":"string","description":"PAN","example":"ABCD1234F","uniqueKey":"pan","typeLabel":"string"},"notes":{"type":"string","description":"Notes","example":"Testing api","uniqueKey":"notes","typeLabel":"string"},"cc_emails":{"type":"string","description":"CC email addresses","example":"reddi@reddi.reddi,acb.a@bcd.con","uniqueKey":"cc_emails","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customer_id":"123","name":"TATA RATAN","phone":1234567890,"email":"reddi@reddi.reddi","discount":10,"gstin":"27AARCS7202C1ZD","company_name":"GSTN","opening_balance":"1245","credit_limit":200,"billing_address":[{"state":"State Name","address_line1":"","address_line2":"","pincode":"500075","city":"","country":"India"}],"shipping_address":[{"state":"State Name","address_line1":"","address_line2":"","pincode":"500075","city":"","country":"India"}],"opening_balance_type":1,"dial_code":"91","profile_image":"","pan":"ABCD1234F","notes":"Testing api","cc_emails":"reddi@reddi.reddi,acb.a@bcd.con"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"8b3a2d8a-da39-4275-965e-af7dd0366f20":{"description":"Success","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Response message","example":"Customer added successfully","uniqueKey":"message","typeLabel":"string"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Customer added successfully"}}},"exampleType":"generated"}},"exampleType":"generated"},"b2b790fd-ef1e-4c56-af1b-ae8241da9f54":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":false,"uniqueKey":"success","typeLabel":"boolean"},"error_code":{"type":"string","description":"Error Code","example":"INVALID_CUSTOMER_ID","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","description":"Response message","example":"Error Message","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors","example":"List of errors","uniqueKey":"errors","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error_code":"INVALID_CUSTOMER_ID","message":"Error Message","errors":"List of errors"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c3ebd91-7e70-4226-80ba-4c10cfc4b75a":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":false,"uniqueKey":"success","typeLabel":"boolean"},"error_code":{"type":"string","description":"Error Code","example":"INVALID_CUSTOMER_ID","uniqueKey":"error_code","typeLabel":"string"},"message":{"type":"string","description":"Response message","example":"Error Message","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors","example":"List of errors","uniqueKey":"errors","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error_code":"INVALID_CUSTOMER_ID","message":"Error Message","errors":"List of errors"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"13576f02-530d-4f08-aab7-91987ee153ab":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","scopes":[]}}},"servers":{"82b38fec-7303-4b6e-86bb-63d990b1e4ef":{"url":"https://app.getswipe.in/api/partner"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"swipe","siteName":"Swipe","title":"Update a customer - Swipe","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/customer-v2/update-a-customer","matchLevel":1},"v1 (Deprecated)":{"href":"/api-reference/customer/update-a-customer","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T07:51:52.660Z","originalFileLocation":"api-reference/customer/update-a-customer.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=\"v1 is deprecated — use the v2 endpoint instead. Updates an existing customer\u0026#x27;s details. Changes propagate to the documents linked to this customer.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Swipe\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a customer - Swipe\">\u003cmeta data-mint-head property=\"og:description\" content=\"v1 is deprecated — use the v2 endpoint instead. Updates an existing customer\u0026#x27;s details. Changes propagate to the documents linked to this customer.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Swipe API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.getswipe.in/api-reference/customer/update-a-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://swipe.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Update+a+customer\u0026amp;description=**v1+is+deprecated+%E2%80%94+use+the+v2+endpoint+instead.**+Updates+an+existing+customer%27s+details.+Changes+propagate+to+the+documents+linked+to+this+customer.\u0026amp;theme=6f6d44835af80bcfb7f23dbb\u0026amp;signature=26de54f499d1ac020d2fbaa0637f4dc8305d96b216a639472ef070bca01d51e1\">\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 a customer - Swipe\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"v1 is deprecated — use the v2 endpoint instead. Updates an existing customer\u0026#x27;s details. Changes propagate to the documents linked to this customer.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://swipe.mintlify.app/_mintlify/api/og/v2?division=Customer\u0026amp;title=Update+a+customer\u0026amp;description=**v1+is+deprecated+%E2%80%94+use+the+v2+endpoint+instead.**+Updates+an+existing+customer%27s+details.+Changes+propagate+to+the+documents+linked+to+this+customer.\u0026amp;theme=6f6d44835af80bcfb7f23dbb\u0026amp;signature=26de54f499d1ac020d2fbaa0637f4dc8305d96b216a639472ef070bca01d51e1\">\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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Swipe\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2045D1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.getswipe.in/api-reference/customer/update-a-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer/update-a-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.getswipe.in/#organization\",\"name\":\"Swipe\",\"url\":\"https://developers.getswipe.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_light.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=44d5e4b626518cb3542e8ef16e85f182\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.getswipe.in#website\",\"name\":\"Swipe\",\"url\":\"https://developers.getswipe.in\",\"publisher\":{\"@id\":\"https://developers.getswipe.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer#webpage\",\"url\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer\",\"name\":\"Update a customer\",\"description\":\"v1 is deprecated — use the v2 endpoint instead. Updates an existing customer's details. Changes propagate to the documents linked to this customer.\",\"dateModified\":\"2026-08-27T07:51:52.660Z\",\"isPartOf\":{\"@id\":\"https://developers.getswipe.in#website\"},\"breadcrumb\":{\"@id\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customer\",\"item\":\"https://developers.getswipe.in/api-reference/customer/add-a-customer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a customer\",\"item\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer#apireference\",\"headline\":\"Update a customer\",\"name\":\"Update a customer\",\"description\":\"v1 is deprecated — use the v2 endpoint instead. Updates an existing customer's details. Changes propagate to the documents linked to this customer.\",\"url\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer\",\"mainEntityOfPage\":{\"@id\":\"https://developers.getswipe.in/api-reference/customer/update-a-customer#webpage\"},\"dateModified\":\"2026-08-27T07:51:52.660Z\",\"publisher\":{\"@id\":\"https://developers.getswipe.in/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.getswipe.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Swipe\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Swipe","nav":{"global":{"anchors":[{"anchor":"Run in Postman","icon":{"style":"thin","name":"user-astronaut"},"href":"https://god.gw.postman.com/run-collection/43895811-b7327b9d-1e50-4fed-af6f-660a918aa817?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D43895811-b7327b9d-1e50-4fed-af6f-660a918aa817%26entityType%3Dcollection%26workspaceId%3D5d3fc3f0-668c-499e-833b-03222666ba2a"},{"anchor":"Blog","icon":"newspaper","href":"https://getswipe.in/blog"},{"anchor":"Community","icon":"slack","href":"https://community.getswipe.in/c/api-integration/14"}]},"versions":[{"version":"v2","pages":[{"title":"v2","href":"/api-reference/customer-v2/update-a-customer"}]},{"version":"v1 (Deprecated)","anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"rocket","href":"/introduction"},{"title":"Quickstart","icon":"play","href":"/quickstart"},{"title":"Authentication","icon":"key","href":"/authentication"},{"title":"API Conventions","icon":"list-check","href":"/api-conventions"},{"title":"Build with AI","icon":"robot","href":"/build-with-ai"}]},{"group":"Guides","pages":[{"title":"Documents","icon":"file-invoice","href":"/document"},{"title":"Customers","icon":"users","href":"/customer"},{"title":"Vendors","icon":"building","href":"/vendor"},{"title":"Payments","icon":"credit-card","href":"/payment"},{"title":"Products","icon":"boxes-stacked","href":"/product"},{"title":"Inventory","icon":"warehouse","href":"/inventory"},{"title":"Subscriptions","icon":"repeat","href":"/subscriptions"},{"title":"E-Way Bills","icon":"truck-fast","href":"/ewaybills"},{"title":"E-Invoices","icon":"file-circle-check","href":"/einvoices"},{"title":"Webhooks","icon":"bolt","href":"/webhooks"}]},{"group":"Resources","pages":[{"title":"Error Codes","icon":"triangle-exclamation","href":"/api-reference/error-codes"},{"title":"Tax Codes (TDS \u0026 TCS)","icon":"percent","href":"/api-reference/tax-codes"},{"title":"Currencies, States \u0026 Countries","icon":"globe","href":"/api-reference/reference-data"},{"title":"Change Log","icon":"clock-rotate-left","href":"/api-reference/change-log"}]},{"group":"Document","pages":[{"openapi":"post /v1/doc","title":"Create a document","href":"/api-reference/document/create-a-document"},{"openapi":"get /v1/doc/pdf/{doc_hash_id}","title":"Get document PDF","href":"/api-reference/document/get-document-pdf"},{"openapi":"delete /v1/doc/{doc_hash_id}","title":"Cancel a document","href":"/api-reference/document/cancel-a-document"}]},{"group":"Payment","pages":[{"openapi":"post /v1/payment","title":"Record payment","href":"/api-reference/payment/record-payment"}]},{"group":"Customer","pages":[{"openapi":"post /v1/customer","title":"Add a customer","href":"/api-reference/customer/add-a-customer"},{"openapi":"get /v1/customer/{customer_id}","title":"Get a customer","description":"**v1 is deprecated — use the v2 endpoint instead.** Returns one customer's details by your `customer_id`.","href":"/api-reference/customer/get-a-customer"},{"openapi":"put /v1/customer","title":"Update a customer","href":"/api-reference/customer/update-a-customer"},{"openapi":"delete /v1/customer/{customer_id}","title":"Delete a customer","description":"**v1 is deprecated — use the v2 endpoint instead.** Deletes a customer by your `customer_id`. Deleted customers move to the Deleted tab in the dashboard.","href":"/api-reference/customer/delete-a-customer"},{"openapi":"get /v1/customer/ledger","title":"Get payment ledger","href":"/api-reference/customer/get-payment-ledger"},{"openapi":"get /v1/customer/list","title":"Get list of customers","href":"/api-reference/customer/get-list-of-customers"},{"openapi":"post /v1/customer/list","title":"Update customer mapping","href":"/api-reference/customer/update-customer-mapping"}]},{"group":"Product","pages":[{"openapi":"post /v1/product","title":"Add an item","href":"/api-reference/product/add-an-item"},{"openapi":"get /v1/product/{item_id}","title":"Get item details","href":"/api-reference/product/get-item-details"},{"openapi":"put /v1/product","title":"Update an item","href":"/api-reference/product/update-an-item"},{"openapi":"delete /v1/product/{item_id}","title":"Delete an item","href":"/api-reference/product/delete-an-item"},{"openapi":"get /v1/product/list","title":"Get list of items","href":"/api-reference/product/get-list-of-items"},{"openapi":"post /v1/product/list","title":"Update items mapping","href":"/api-reference/product/update-items-mapping"}]},{"group":"Subscriptions","pages":[{"openapi":"get /v1/subscriptions/list","title":"List of subscriptions","href":"/api-reference/subscriptions/list-of-subscriptions"},{"openapi":"get /v1/subscriptions/{subscription_hash_id}","title":"Get subscription details","href":"/api-reference/subscriptions/get-subscription-details"}]},{"group":"Utility","pages":[{"openapi":"get /v1/utils/gstin/{gstin}","title":"Get GSTIN details","href":"/api-reference/utility/get-gstin"}]},{"group":"EwayBill","pages":[{"openapi":"get /v2/ewaybill/pdf/{doc_hash_id}","title":"Get e-way bill PDF","href":"/api-reference/ewaybill/get-ewaybill-pdf"},{"openapi":"post /v2/ewaybill/{doc_hash_id}","title":"Create e-way bill","href":"/api-reference/ewaybill/create-eway-bill"}]}]}]}]},"title":"Update a customer - Swipe","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}