Skip to main content
PUT
/
organizations
/
{orgId}
/
catalogs
/
{catalogId}
Update Catalog
curl --request PUT \
  --url https://api.joinrefine.io/organizations/{orgId}/catalogs/{catalogId} \
  --header 'Content-Type: application/json' \
  --header 'REFINE_API_KEY: <api-key>' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "productCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

​
orgId
string<uuid>
required

Organization ID (UUID)

​
catalogId
string<uuid>
required

Catalog ID (UUID)

Body

application/json
​
id
string<uuid>
required

Catalog ID (must match path parameter)

​
name
string
required

New catalog name

​
organizationId
string<uuid>
required

Organization ID (must match path parameter)

​
description
string

New catalog description

Response

Catalog updated successfully

​
id
string<uuid>

Catalog ID

​
name
string

Catalog name

​
description
string

Catalog description

​
organizationId
string<uuid>

Organization ID

​
productCount
integer

Number of products in catalog

​
createdAt
string<date-time>

Creation timestamp

​
updatedAt
string<date-time>

Last update timestamp