Workspace

Update Profile

PATCHhttps://voxa.abhinavyadav.in/api/v1/workspace/profile

Update the organization’s address, GSTIN and contact details after KYC approval. Legal name, business type and PAN can’t be changed here. Invoices already issued keep their details.

Authorization

A signed-in member with the kyc.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearerkyc.manage

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

gstinstring | null

at most 15 characters

address_linestring | null

at most 300 characters

citystring | null

at most 80 characters

statestring | null

at most 80 characters

pincodestring | null

at most 6 characters

contact_namestring | null

at most 80 characters

contact_phonestring | null

at most 16 characters

websitestring | null

at most 200 characters

Response

200Success.

No body.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request PATCH \
  --url 'https://voxa.abhinavyadav.in/api/v1/workspace/profile?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "gstin": null,
  "address_line": null,
  "city": null,
  "state": null,
  "pincode": null,
  "contact_name": null,
  "contact_phone": null,
  "website": null
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/workspace/profile"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "gstin": None,
    "address_line": None,
    "city": None,
    "state": None,
    "pincode": None,
    "contact_name": None,
    "contact_phone": None,
    "website": None,
}

response = requests.patch(url, params=params, headers=headers, json=payload)
print(response.status_code, response.json())

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/workspace/profile?timezone=Asia/Kolkata", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "gstin": null,
    "address_line": null,
    "city": null,
    "state": null,
    "pincode": null,
    "contact_name": null,
    "contact_phone": null,
    "website": null
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (kyc.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}