Update a customer - Swipe

Update a customer

curl --request PUT \
  --url https://app.getswipe.in/api/partner/v2/customer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "123",
  "name": "TATA RATAN"
}
'

import requests

url = "https://app.getswipe.in/api/partner/v2/customer"

payload = {
    "customer_id": "123",
    "name": "TATA RATAN"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({customer_id: '123', name: 'TATA RATAN'})
};

fetch('https://app.getswipe.in/api/partner/v2/customer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

PUT

/

v2

/

customer

Update a customer

curl --request PUT \
  --url https://app.getswipe.in/api/partner/v2/customer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "123",
  "name": "TATA RATAN"
}
'

import requests

url = "https://app.getswipe.in/api/partner/v2/customer"

payload = {
    "customer_id": "123",
    "name": "TATA RATAN"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({customer_id: '123', name: 'TATA RATAN'})
};

fetch('https://app.getswipe.in/api/partner/v2/customer', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "message": "No data found!"
  }
}

Authorizations

Authorization

string

header

required

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.

Body

application/json

customer_id

string

required

Your Customer ID

Example:

"123"

name

string

required

Customer name

Example:

"TATA RATAN"

phone

string

Phone number

Example:

1234567890

email

string

Email address

Example:

"reddi@reddi.reddi"

cc_emails

string

CC email addresses, comma-separated

Example:

"a@example.com,b@example.com"

discount

integer

Discount

Example:

10

gstin

string

GSTIN

Example:

"27AARCS7202C1ZD"

company_name

string

Company name

Example:

"GSTN"

opening_balance

string

Opening balance

Example:

"1245"

credit_limit

integer

Credit limit

Example:

200

billing_address

object[]

List of billing addresses

Show child attributes

shipping_address

object[]

List of shipping addresses

Show child attributes

opening_balance_type

integer

Credit[0] / Debit[1]

Example:

1

dial_code

string

Dial code

Example:

"91"

profile_image

string

Profile image URL

Example:

""

pan

string

PAN

Example:

"ABCD1234F"

notes

string

Notes

Example:

"Testing api"

tags

string[]

List of tags

custom_fields

object[]

Customer Custom Fields. Custom fields should already be added in Swipe Portal.

Show child attributes

Example:

[
  {
    "label": "Custom Field 1",
    "value": "Value 1"
  }
]

visibility

integer

Customer visibility status: If the value is 1, the customer will be visible to all branches; otherwise, it will only be visible in the main branch.

Example:

1

Response

Success

success

boolean

Success flag

Example:

true

message

string

Response message

Example:

""

error_code

string

Error Code

Example:

""

errors

object

Errors

data

object

Show child attributes