Return Status (Blocked and Unblocked)

Blocked and Unblocked API

Request Method

POST

Request Path

{{API_URL}}/api/v1/returnStatus/

Request Headers

Parameter	Value	Description
Authorization/api_key	api_key/auth token	Value and header type is mentioned in the Authentication Page

Request Body

The request body description for the API can be found here.

Sample Request

{
    "user_gstin": "XXXXXXXXXXXXXXX",
    "GSTIN_Status":"N",
    "gstin_list": [
        {
            "gstin": "XXXXXXXXXXXXXXX"
        },
        {
            "gstin": "XXXXXXXXXXXXXXX"
        }
    ]
}

Response Body

200 (OK)

The response description for success can be found here.

Sample Response

{
  "results": {
    "message": {
      "XXXXXXXXXXXXXXX": "Unblocked",
      "XXXXXXXXXXXXXXX": "Unblocked"
    },
    "status": "Success",
    "code": 200
  }
}

204 (Invalid Parameters)

{
  "results": {
    "message": {
      "XXXXXXXXXXXXXXX": "Incorrect user id/User does not exists",
      "XXXXXXXXXXXXXXX": "Incorrect user id/User does not exists"
    },
    "status": "Fail",
    "code": 204
  }
}