Rename product

Request, parameters and responses for this API endpoint.

PATCH/api/v1/customer/products/{id}

Overview

This endpoint requires an API key with write access. Its creator must still be the user of the customer account.

Headers & parameters

AuthorizationBearer $SYSTEY_API_KEY · required

Content-Typeapplication/json

idpath · required

{"type":"string","format":"uuid"}

Request body

Send a JSON object. Required fields refer to their containing object. Business requirements for the endpoint also apply; unknown fields are rejected.

Schema fields and requirements
Field	Type	Required
`name` minLength: 1 · maxLength: 120	string	Yes

Example request

Replace placeholders with your own values. Persist $REQUEST_UUID before a mutation if this endpoint requires an Idempotency-Key.

cURL

curl -i -X PATCH "https://systey.com/api/v1/customer/products/<resource UUID>" \
  -H "Authorization: Bearer $SYSTEY_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Produktionsserver"
}'

Response

HTTP 200

Schema fields and requirements
Field	Type	Required
`data`	object	Yes
`data.id` uuid	string	Yes
`data.name`	string	Yes
`data.description`	string \| null	Yes
`data.specificationItems`	array	Yes
`data.specificationItems[]`	object	—
`data.specificationItems[].label`	string	Yes
`data.specificationItems[].value`	string	Yes
`data.status` "ACTIVE" \| "PAUSED" \| "CANCELLED"	string	Yes
`data.sandbox`	boolean	Yes
`data.category` string \| null	string \| null	Yes
`data.priceCents`	integer	Yes
`data.billingCycle` "ONCE" \| "MONTHLY" \| "YEARLY"	string	Yes
`data.commercialModel` "CONTRACT" \| "PREPAID"	string	Yes
`data.renewalMode` "NONE" \| "AUTOMATIC" \| "CUSTOMER"	string	Yes
`data.contractTermMonths`	number \| null	Yes
`data.minimumTermMonths`	number \| null	Yes
`data.renewalMonths`	number \| null	Yes
`data.noticeDays`	number \| null	Yes
`data.serviceStartedAt` date-time \| null	string \| null	Yes
`data.serviceEndsAt` date-time \| null	string \| null	Yes
`data.cancelRequestedAt` date-time \| null	string \| null	Yes
`data.cancelEffectiveAt` date-time \| null	string \| null	Yes
`data.hostname`	string \| null	Yes
`data.ipAddress`	string \| null	Yes
`data.createdAt` date-time	string	Yes
`data.updatedAt` date-time	string	Yes
`data.domain` object \| null	object \| null	Yes
`data.domain.name`	string	Yes
`data.domain.status`	string	Yes
`data.domain.expiresAt` date-time \| null	string \| null	Yes
`data.domain.sandbox`	boolean	Yes

Errors

Error responses contain error and optionally message and details. Rate limit: 120 requests per minute per key. On HTTP 429 respect Retry-After.