Skip to main content
POST

​
Request body schema

View request body schema

View request body schema

Authorizations

​
authorization
string
header
required

GST taxpayer access token returned by Verify OTP.

​
x-api-key
string
header
required

Sandbox API key from your Sandbox account.

Headers

​
x-api-version
string
default:1.0.0

API version

Body

application/json

Public request body for Save Preference.

​
gstin
string
required

GSTIN for which the filing preference is saved.

Required string length: 15
Example:

"27COWPR1617C2ZN"

​
fy
string
required

The fy value provided in the request.

Example:

"2020-21"

​
preference
enum<string>
required

The preference value provided in the request.

Available options:
Q,
M
Example:

"M"

​
quarter
enum<string>
required

The quarter value provided in the request.

Available options:
Q1,
Q2,
Q3,
Q4
Example:

"Q2"

Response

200 - application/json

GSTN success or business-error response. GSTN returns both variants with HTTP 200.

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

​
code
enum<integer>
required

The HTTP status code reported in the response body.

Available options:
200
Example:

200

​
timestamp
integer<int64>
required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

​
transaction_id
string
required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

​
data
object
required

The GSTN success wrapper.