put/productsWrite operation

Update product

Use the frozen API v0 contract to update product. Uses the broad legacy payload contract and returns the historical v0 response envelope. Authentication scopes the request to the workspace that issued the token.

Request example

curl --request PUT \
  --url 'https://api.teamgrid.app/products' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data 'null'

const response = await fetch('https://api.teamgrid.app/products', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(null),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.teamgrid.app/products', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(null),
})

const result: ApiResponse = await response.json()

Example response 2xx

{
  "data": null,
  "info": "string",
  "pagination": null,
  "status": null,
  "statusCode": 0
}

EndpointLegacy API

Request body

application/json

Schema type: object

Responses

200The legacy request to update product succeeded and returned the historical v0 response envelope.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

201The legacy request to update product created a resource and returned the v0 response envelope.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

204The request to update product completed successfully and returns no response body.

400Legacy request failure.application/json

Response schemaapplication/json

data

object

Response data for the completed request.

info

string

The info associated with this legacy.

pagination

objectnullable

The pagination associated with this legacy.

status

stringnullable

Canonical status of the resource or operation.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

401Authentication failed.application/json

Response schemaapplication/json

error

string

Sanitized failure information when the operation did not succeed.

message

string

Human-readable explanation intended to help diagnose the result.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

429Rate limit exceeded.application/json

Response schemaapplication/json

error

string

Sanitized failure information when the operation did not succeed.

message

string

Human-readable explanation intended to help diagnose the result.

statusCoderequired

integer

HTTP status code represented by this legacy response envelope.

Operation IDv0_put_productsOpenAPI JSON ↗

Documentation feedbackWas this page useful?