Skip to main content
PUT
Update a product

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
enum<string>
default:v1

Your API version

Available options:
v1
Content-Type
enum<string>
Available options:
application/json,
application/xml,
application/x-www-form-urlencoded,
application/octet-stream,
application/pdf,
text/plain,
text/html,
multipart/form-data

Path Parameters

id
string
required

Body

application/json
name
string
required
Example:

"Product Name"

description
string
required
Example:

"Product description"

owner_id
string<uuid>
required
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Success

id
string<uuid>
required
Example:

"9068ec25-b433-4bc4-8e99-bbbc4de2d43d"

name
string
required
Example:

"Newsletter"

description
string
required
Example:

"Newsletter product description"

owner_id
string<uuid>
required
Example:

"c8cc354b-09c1-4dc8-bd4c-f44d2339cb9a"

workspace_id
string<uuid>
required
Example:

"9d6ee3f1-99f1-4be3-b85b-66f8b02be516"

created_at
string<date-time>
required
Example:

"2023-05-07T00:00:00Z"

updated_at
string<date-time>
required
Example:

"2023-05-07T00:00:00Z"

status
enum<string>
Available options:
active,
inactive
created_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

updated_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"