Blog Categories

Blog Category limits

GET read_blog

Fetch Blog Category limits and per-field constraints.

Returns the per-field maximum lengths and request caps that apply to Blog Category endpoints. Useful for clients to validate inputs before sending them and to size UIs. max_per_store is this store's plan cap, count is how many exist now, and usage is the localized label.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl 'https://api-store.tringify.com/api/2025-01/blog/categories/limits' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/limits", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/blog/categories/limits",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "bulk_delete_max_items": 500,
    "count": 1,
    "description_max_length": 5000,
    "list_max_limit": 100,
    "list_page_size": 50,
    "max_per_store": 5,
    "name_max_length": 100,
    "page_size_options": [
      20,
      50,
      100
    ],
    "search_max_length": 200,
    "seo_description_max_length": 160,
    "seo_title_max_length": 70,
    "slug_max_length": 100,
    "sort_columns": [
      "name",
      "post_count",
      "created_at",
      "updated_at"
    ],
    "usage": "Blog categories 1 of 5"
  },
  "success": true
}

List blog categories

GET read_blog

List blog categories for the store.

Returns paginated Blog Categories. total counts matches for the current filters; store_total counts all records in the store and can be compared with the store capacity returned by the limits endpoint. Use search to filter by name or slug. Invalid pagination and unsupported sort values are rejected. storefront_url is the canonical absolute URL on the store's primary domain. storefront_path is the domain-independent baseline route; join it to the storefront address you are targeting. Hosted storefront responses apply translated slugs and locale/country prefixes.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size, up to `list_max_limit` from the Blog Category limits. Example: `20`
`search`	`string`	Search Blog Categories by name or slug. Example: `company-news`
`sort_by`	`string`	Sort field from the Blog Category list contract. Allowed values `namepost_countcreated_atupdated_at` Example: `name`
`sort_direction`	`string`	Sort direction from the Blog Category list contract. Allowed values `ascdesc` Example: `asc`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 VALIDATION_LIST_INVALID_PAGE
Page must be a positive integer.
400 VALIDATION_LIST_INVALID_LIMIT
Limit must be a positive integer within the contract cap.
400 VALIDATION_LIST_INVALID_SORT_BY
Sort field is not supported for this endpoint.
400 VALIDATION_LIST_INVALID_SORT_DIRECTION
Sort direction must be asc or desc.
400 BLOG_CATEGORY_SEARCH_TOO_LONG
Search exceeds the Blog Category contract max length.

curl 'https://api-store.tringify.com/api/2025-01/blog/categories?limit=20&page=1&search=company-news&sort_by=name&sort_direction=asc' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories?limit=20&page=1&search=company-news&sort_by=name&sort_direction=asc", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/blog/categories?limit=20&page=1&search=company-news&sort_by=name&sort_direction=asc",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "categories": [
      {
        "created_at": "2026-06-09T12:00:00+05:30",
        "description": "Updates and announcements from the company.",
        "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
        "name": "Company News",
        "post_count": 8,
        "seo_description": "Read company updates, product notes, and announcements.",
        "seo_title": "Company News",
        "slug": "company-news",
        "storefront_path": "/blog-category/company-news",
        "storefront_url": "https://store.example.com/blog-category/company-news",
        "template_handle": "default_blog_category",
        "updated_at": "2026-06-09T12:00:00+05:30"
      }
    ],
    "limit": 20,
    "page": 1,
    "sort_by": "name",
    "sort_direction": "asc",
    "store_total": 1,
    "total": 1
  },
  "success": true
}

Get a blog category

GET read_blog

Fetch one blog category by id.

Returns the Blog Category if it belongs to the token's store. storefront_url is the canonical absolute URL on the store's primary domain. storefront_path is the domain-independent baseline route; join it to the storefront address you are targeting. Hosted storefront responses apply translated slugs and locale/country prefixes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Blog Category id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 STORE_API_INVALID_CATEGORY_ID
Blog Category id is not a valid UUID.
404 NOT_FOUND
Blog Category does not exist in this store.

curl 'https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "storefront_path": "/blog-category/company-news",
    "storefront_url": "https://store.example.com/blog-category/company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "success": true
}

List blog category metafields

GET read_blog

List custom-data values visible to the token.

Definitions are filtered through the token's access rules.

Path parameters

Name	Type	Description
`id` required	`uuid`	Blog Category id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Query parameters

Name	Type	Description
`page`	`integer`	Page number (default 1).
`limit`	`integer`	Page size; capped by the metafield list limit.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

400 VALIDATION_LIST_INVALID_PAGE
Page must be a positive integer.
400 VALIDATION_LIST_INVALID_LIMIT
Limit must be a positive integer.
404 NOT_FOUND
The resource does not exist in this store.

curl 'https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields", {
  method: "GET",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "limit": 50,
    "metafields": [
      {
        "created_at": "2026-09-01T12:00:00Z",
        "definition": {
          "app_access": "private",
          "buyer_access": "hidden",
          "created_at": "2026-09-01T12:00:00Z",
          "id": "642a703a-9639-4d25-8d02-426f6f9f7d12",
          "is_filterable": false,
          "is_searchable": false,
          "is_storefront_visible": true,
          "is_translatable": true,
          "key": "subtitle",
          "merchant_access": "read_write",
          "name": "Subtitle",
          "namespace": "details",
          "owner_type": "blog_category",
          "sort_order": 0,
          "type": "string",
          "updated_at": "2026-09-01T12:00:00Z",
          "usage_count": 0
        },
        "updated_at": "2026-09-01T12:00:00Z",
        "value": "Company news"
      }
    ],
    "page": 1,
    "total": 1,
    "total_pages": 1
  },
  "success": true
}

Set blog category metafields

PUT write_blog

Create, update, or delete custom-data values.

Send namespace-and-key entries. A string value creates or replaces a value; null or an empty string deletes it. The complete value change succeeds or fails together. Omitted entries are preserved.

Path parameters

Name	Type	Description
`id` required	`uuid`	Blog Category id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`metafields` required	`array<object>`	Entries shaped as `{namespace, key, value}`. `value` is required in every entry; send `null` or an empty string to delete the stored value. Example: `[{"namespace":"details","key":"subtitle","value":"Company"}]`

Errors

400 STORE_API_INVALID_REQUEST_BODY
The body or entry shape is invalid. Each entry requires an explicit value, including null for deletion.
400 METAFIELD_NO_WRITES
Provide at least one metafield entry.
400 METAFIELD_DUPLICATE_WRITE
A namespace and key occur more than once.
400 PRODUCT_METAFIELD_DEF_NOT_FOUND
The namespace and key do not identify a definition visible to this token. For an app token only its own definitions count: merchant-owned and other apps' definitions return this code.
403 METAFIELD_WRITE_MERCHANT_READ_ONLY
The definition does not grant value write access.
403 STORE_API_SCOPE_REQUIRED
Binding a nonempty file_reference or list.file_reference also requires read_files. Clearing a reference does not.
404 NOT_FOUND
The resource does not exist in this store. A file reference names a file that does not exist in this store.
400 METAFIELD_VALUE_TOO_LONG
The value exceeds its size limit: the definition's max_value_length, or the platform value size limit for the type.
400 METAFIELD_VALUE_STRING_TOO_LONG
A string value exceeds the definition's max_value_length or the platform string limit.
400 METAFIELD_VALUE_TOO_SHORT
A string value is shorter than the definition's min_length rule.
400 METAFIELD_VALUE_PATTERN_MISMATCH
A string value does not match the definition's pattern rule.
400 METAFIELD_VALUE_INTEGER_INVALID
An integer value is not a whole number in the 64-bit range.
400 METAFIELD_VALUE_INTEGER_TOO_LONG
An integer value has more digits than the definition or the platform integer limit allows.
400 METAFIELD_VALUE_DECIMAL_INVALID
A decimal value is not a finite decimal number.
400 METAFIELD_VALUE_DECIMAL_TOO_LONG
A decimal value, written out in full, is longer than the definition or the platform decimal limit allows.
400 METAFIELD_VALUE_BELOW_MIN
An integer or decimal value is below the definition's min rule.
400 METAFIELD_VALUE_ABOVE_MAX
An integer or decimal value is above the definition's max rule.
400 METAFIELD_VALUE_BOOLEAN_INVALID
A boolean value is not true or false.
400 METAFIELD_VALUE_DATE_INVALID
A date value is not a calendar date in YYYY-MM-DD form.
400 METAFIELD_VALUE_DATETIME_INVALID
A datetime value is not YYYY-MM-DDTHH:mm, YYYY-MM-DDTHH:mm:ss or an RFC 3339 timestamp.
400 METAFIELD_VALUE_JSON_INVALID
A json value is not valid JSON.
400 METAFIELD_VALUE_JSON_UNSAFE_LINK
A json value contains a link whose scheme is not http, https, mailto or tel.
400 METAFIELD_VALUE_URL_INVALID
A url value, or an item of a list.url value, is not an absolute URL with a host.
400 METAFIELD_VALUE_URL_SCHEME
A url value, or an item of a list.url value, does not use http or https.
400 METAFIELD_VALUE_URL_TOO_LONG
A url value, or an item of a list.url value, exceeds the definition's max_value_length or the platform URL limit.
400 METAFIELD_VALUE_NOT_IN_CHOICES
A single_select value is not one of the definition's choice keys.
400 METAFIELD_LIST_CHOICE_INVALID
An item of a list.single_select value is not one of the definition's choice keys; the message names the item.
400 METAFIELD_LIST_STRINGS_INVALID
A list.string or list.single_select value is not a JSON array of strings.
400 METAFIELD_LIST_URLS_INVALID
A list.url value is not a JSON array of strings.
400 METAFIELD_LIST_FILES_INVALID
A list.file_reference value is not a JSON array of strings.
400 METAFIELD_LIST_IDS_INVALID
A list.product_reference or list.variant_reference value is not a JSON array of integers.
400 METAFIELD_LIST_EMPTY
A list value other than list.string is an empty array. Send null or an empty string to remove the value instead.
400 METAFIELD_LIST_TOO_MANY
A list value has more items than the definition's max_list_items or the platform list limit for the type.
400 METAFIELD_LIST_ITEM_EMPTY
An item of a list.string value is empty or only whitespace; the message names the item.
400 METAFIELD_LIST_ITEM_TOO_LONG
An item of a list.string value exceeds the definition's max_value_length or the platform string limit; the message names the item.
400 METAFIELD_VALUE_FILE_UUID_INVALID
A file_reference value, or an item of a list.file_reference value, is not a file UUID.
400 METAFIELD_VALUE_ID_INVALID
A product_reference or variant_reference value is not an integer ID.
400 METAFIELD_VALUE_ID_POSITIVE
A product_reference or variant_reference value is not a positive integer.
400 METAFIELD_VALUE_ID_TOO_LONG
A product_reference or variant_reference value exceeds the platform reference ID limit.
400 METAFIELD_LIST_ITEMS_POSITIVE
An item of a list.product_reference or list.variant_reference value is not a positive integer.
400 METAFIELD_REFERENCE_PRODUCT_MISSING
A product reference names a product that does not exist in this store.
400 METAFIELD_REFERENCE_VARIANT_MISSING
A variant reference names a variant that does not exist in this store.
400 INVALID_INPUT
A file reference names a file that is not an uploaded file.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "metafields": [
    {
      "key": "subtitle",
      "namespace": "details",
      "value": "Company"
    }
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "metafields": [
      {
        "key": "subtitle",
        "namespace": "details",
        "value": "Company"
      }
    ]
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31/metafields",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "metafields": [{
            "key": "subtitle",
            "namespace": "details",
            "value": "Company",
        }],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "limit": 50,
    "metafields": [
      {
        "created_at": "2026-09-01T12:00:00Z",
        "definition": {
          "app_access": "private",
          "buyer_access": "hidden",
          "created_at": "2026-09-01T12:00:00Z",
          "id": "642a703a-9639-4d25-8d02-426f6f9f7d12",
          "is_filterable": false,
          "is_searchable": false,
          "is_storefront_visible": true,
          "is_translatable": true,
          "key": "subtitle",
          "merchant_access": "read_write",
          "name": "Subtitle",
          "namespace": "details",
          "owner_type": "blog_category",
          "sort_order": 0,
          "type": "string",
          "updated_at": "2026-09-01T12:00:00Z",
          "usage_count": 0
        },
        "updated_at": "2026-09-01T12:00:00Z",
        "value": "Company news"
      }
    ],
    "page": 1,
    "total": 1,
    "total_pages": 1
  },
  "success": true
}

Create a blog category

POST write_blog

Create a blog category.

Creates a Blog Category. name is required. slug is optional on create; when omitted or empty, the backend generates it from the name. Optional SEO and template fields follow the Blog Category resource contract. storefront_url is the canonical absolute URL on the store's primary domain. storefront_path is the domain-independent baseline route; join it to the storefront address you are targeting. Hosted storefront responses apply translated slugs and locale/country prefixes.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name` required	`string`	Blog Category name. Example: `Company News`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `company-news`
`description`	`string`	Optional plain-text description. Example: `Updates and announcements from the company.`
`seo_title`	`string`	Optional SEO title. Example: `Company News`
`seo_description`	`string`	Optional SEO description. Example: `Read company updates, product notes, and announcements.`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_blog_category`. Use `default_blog_category` for the default Blog Category template, or pass an alternate Blog Category template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_blog_category` to reset it to default, and do not send an empty string. Example: `default_blog_category`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 BLOG_CATEGORY_NAME_REQUIRED
Name is empty after normalization.
400 BLOG_CATEGORY_NAME_TOO_LONG
Name exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SLUG_FORMAT
Slug is not valid for Blog Category URLs.
400 BLOG_CATEGORY_SLUG_TOO_LONG
Slug exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SLUG_GENERATION_FAILED
A slug could not be generated from the supplied name.
400 BLOG_CATEGORY_UNIQUE_SLUG_GENERATION_FAILED
A unique generated slug could not be found; supply a slug explicitly.
400 BLOG_CATEGORY_DESCRIPTION_TOO_LONG
Description exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SEO_TITLE_TOO_LONG
SEO title exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_LIMIT_REACHED
Store Blog Category cap has been reached.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Blog Category templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle does not exist on the store's primary active theme for Blog Category.
409 BLOG_CATEGORY_DUPLICATE
Name or slug already exists in this store.
400 BLOG_CATEGORY_PLAN_LIMIT_REACHED
This store is at its plan blog category cap.

curl -X POST 'https://api-store.tringify.com/api/2025-01/blog/categories' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Updates and announcements from the company.",
  "name": "Company News",
  "seo_description": "Read company updates, product notes, and announcements.",
  "seo_title": "Company News",
  "slug": "company-news",
  "template_handle": "default_blog_category"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "description": "Updates and announcements from the company.",
    "name": "Company News",
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/blog/categories",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "description": "Updates and announcements from the company.",
        "name": "Company News",
        "seo_description": "Read company updates, product notes, and announcements.",
        "seo_title": "Company News",
        "slug": "company-news",
        "template_handle": "default_blog_category",
    },
)
data = res.json()

Response

201

Sample response

{
  "code": "BLOG_CATEGORY_CREATED",
  "data": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 0,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "storefront_path": "/blog-category/company-news",
    "storefront_url": "https://store.example.com/blog-category/company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  },
  "message": "Blog Category 'Company News' created.",
  "success": true
}

Update a blog category

PUT write_blog

Update a blog category.

Updates provided Blog Category fields. Omitted fields are left unchanged. When slug is provided it must be non-empty and valid; create is the only path that auto-generates a blank slug from the name. storefront_url is the canonical absolute URL on the store's primary domain. storefront_path is the domain-independent baseline route; join it to the storefront address you are targeting. Hosted storefront responses apply translated slugs and locale/country prefixes.

Path parameters

Name	Type	Description
`id` required	`uuid`	Blog Category id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name`	`string`	Blog Category name. Example: `Company News`
`slug`	`string`	New slug. Omit to leave the current slug unchanged; an empty value is invalid. Example: `company-news`
`description`	`string`	Optional plain-text description. Example: `Updates and announcements from the company.`
`seo_title`	`string`	Optional SEO title. Example: `Company News`
`seo_description`	`string`	Optional SEO description. Example: `Read company updates, product notes, and announcements.`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_blog_category`. Use `default_blog_category` for the default Blog Category template, or pass an alternate Blog Category template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_blog_category` to reset it to default, and do not send an empty string. Example: `default_blog_category`
`create_redirect`	`boolean`	When slug changes, create a redirect from the previous slug. Example: `true`

Errors

400 STORE_API_INVALID_CATEGORY_ID
Blog Category id is not a valid UUID.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
409 TRANSLATION_SOURCE_FIELD_HAS_TRANSLATIONS
Clearing a source field is blocked while translated values exist.
404 NOT_FOUND
Blog Category does not exist in this store.
400 BLOG_CATEGORY_NAME_REQUIRED
Name is empty after normalization.
400 BLOG_CATEGORY_NAME_TOO_LONG
Name exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SLUG_FORMAT
Slug is not valid for Blog Category URLs.
400 BLOG_CATEGORY_SLUG_TOO_LONG
Slug exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SLUG_GENERATION_FAILED
A slug could not be generated from the supplied name.
400 BLOG_CATEGORY_UNIQUE_SLUG_GENERATION_FAILED
A unique generated slug could not be found; supply a slug explicitly.
400 BLOG_CATEGORY_DESCRIPTION_TOO_LONG
Description exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SEO_TITLE_TOO_LONG
SEO title exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the Blog Category contract max length.
400 BLOG_CATEGORY_LIMIT_REACHED
Store Blog Category cap has been reached.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Blog Category templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle does not exist on the store's primary active theme for Blog Category.
409 BLOG_CATEGORY_DUPLICATE
Name or slug already exists in this store.
400 BLOG_CATEGORY_NAME_EMPTY
A provided update name is empty after normalization.
400 BLOG_CATEGORY_SLUG_REQUIRED
Slug is empty on update. Blank slug auto-generation is only available on create.

curl -X PUT 'https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "create_redirect": true,
  "description": "Updates and announcements from the company.",
  "name": "Company News",
  "seo_description": "Read company updates, product notes, and announcements.",
  "seo_title": "Company News",
  "slug": "company-news",
  "template_handle": "default_blog_category"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "PUT",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "create_redirect": true,
    "description": "Updates and announcements from the company.",
    "name": "Company News",
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "create_redirect": True,
        "description": "Updates and announcements from the company.",
        "name": "Company News",
        "seo_description": "Read company updates, product notes, and announcements.",
        "seo_title": "Company News",
        "slug": "company-news",
        "template_handle": "default_blog_category",
    },
)
data = res.json()

Response

200

Sample response

{
  "code": "BLOG_CATEGORY_UPDATED",
  "data": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "storefront_path": "/blog-category/company-news",
    "storefront_url": "https://store.example.com/blog-category/company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:05:00+05:30"
  },
  "message": "Blog Category 'Company News' updated.",
  "success": true
}

Delete a blog category

DELETE write_blog

Delete a blog category.

Deletes a Blog Category only when no blog posts are assigned to it. Assigned posts block deletion. If menus link to it, the first request returns CONFIRMATION_REQUIRED listing the menu links that will be removed; retry with the returned token to delete.

Path parameters

Name	Type	Description
`id` required	`uuid`	Blog Category id. Example: `5ff7d4ea-3250-4a4d-9d26-07f64d917d31`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`confirmed`	`boolean`	Set true only when retrying after CONFIRMATION_REQUIRED. Example: `true`
`confirmation_token`	`string`	Token returned by CONFIRMATION_REQUIRED. Example: `confirm_...`

Errors

400 STORE_API_INVALID_CATEGORY_ID
Blog Category id is not a valid UUID.
404 NOT_FOUND
Blog Category does not exist in this store.
409 BLOG_CATEGORY_HAS_POSTS
Blog Category is assigned to blog posts and cannot be deleted until posts are removed from it.
409 CONFIRMATION_REQUIRED
Menus link to the blog category. Review the warning and retry with the returned token.
400 BLOG_CATEGORY_CONFIRMATION_INVALID
The confirmation token is missing, expired, or does not match this delete.

curl -X DELETE 'https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmation_token": "confirm_...",
  "confirmed": true
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31", {
  method: "DELETE",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "confirmation_token": "confirm_...",
    "confirmed": true
  }),
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/blog/categories/5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "confirmation_token": "confirm_...",
        "confirmed": True,
    },
)
data = res.json()

Response

200

Sample response

{
  "code": "BLOG_CATEGORY_DELETED",
  "message": "Blog Category 'Company News' deleted.",
  "success": true
}

Bulk delete blog categories

POST write_blog

Delete multiple blog categories.

Deletes unassigned Blog Categories together. Any that are missing, or still assigned to blog posts, are reported as failures and left in place. If menus link to the rest, the first request returns CONFIRMATION_REQUIRED; retry the same IDs with the returned token.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`category_ids` required	`array<uuid>`	Blog Category ids to delete. Example: `["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"]`
`confirmed`	`boolean`	Set true only when retrying after CONFIRMATION_REQUIRED. Example: `true`
`confirmation_token`	`string`	Token returned by CONFIRMATION_REQUIRED. Example: `confirm_...`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 STORE_API_INVALID_CATEGORY_ID
One category id is not a valid UUID.
400 BLOG_CATEGORY_BULK_NO_IDS
No Blog Category ids were provided.
400 BLOG_CATEGORY_BULK_DELETE_TOO_MANY
Batch exceeds the Blog Category bulk delete cap.
409 BLOG_CATEGORY_BULK_RACED
Blog Category changed during deletion. Retry with fresh data.
409 CONFIRMATION_REQUIRED
Menus link to selected blog categories. Review the warning and retry the same IDs with the returned token.
400 BLOG_CATEGORY_CONFIRMATION_INVALID
The confirmation token is missing, expired, or does not match the selected IDs.

curl -X POST 'https://api-store.tringify.com/api/2025-01/blog/categories/bulk-delete' \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "category_ids": [
    "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
  ],
  "confirmation_token": "confirm_...",
  "confirmed": true
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/blog/categories/bulk-delete", {
  method: "POST",
  headers: {"Authorization":"Bearer YOUR_STORE_API_TOKEN","Content-Type":"application/json"},
  body: JSON.stringify({
    "category_ids": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ],
    "confirmation_token": "confirm_...",
    "confirmed": true
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/blog/categories/bulk-delete",
    headers={"Authorization":"Bearer YOUR_STORE_API_TOKEN"},
    json={
        "category_ids": ["5ff7d4ea-3250-4a4d-9d26-07f64d917d31"],
        "confirmation_token": "confirm_...",
        "confirmed": True,
    },
)
data = res.json()

Response

200

Sample response

{
  "code": "BLOG_CATEGORIES_DELETED",
  "data": {
    "deleted": [
      "5ff7d4ea-3250-4a4d-9d26-07f64d917d31"
    ],
    "failed": []
  },
  "message": "1 blog categories deleted.",
  "success": true
}

Field	Type	Create	Update	Required	Translatable
`name`	string	Yes	Yes	create	Yes
`slug`	string	Yes	Yes		Yes
`description`	string	Yes	Yes		Yes
`seo_title`	string	Yes	Yes		Yes
`seo_description`	string	Yes	Yes		Yes
`template_handle`	string	Yes	Yes		No
`create_redirect`	boolean	No	Yes		No
`post_count`	integer	No	No		No
`created_at`	string (RFC 3339)	No	No		No
`updated_at`	string (RFC 3339)	No	No		No
`storefront_url`	url	No	No	No	No
`storefront_path`	string	No	No	No	No

Blog category created

EVENT blog_categories/create App scope: read_blog Staff permission: blog:write

Fired when a blog category is created.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog category updated

EVENT blog_categories/update App scope: read_blog Staff permission: blog:write

Fired when a blog category is updated.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`blog_category.description`	`string`	Selectable in the Payload builder
`blog_category.seo_title`	`string`	Selectable in the Payload builder
`blog_category.seo_description`	`string`	Selectable in the Payload builder
`blog_category.template_handle`	`string`	Selectable in the Payload builder
`blog_category.post_count`	`integer`	Selectable in the Payload builder
`blog_category.created_at`	`string`	Selectable in the Payload builder
`blog_category.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "description": "Updates and announcements from the company.",
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "post_count": 8,
    "seo_description": "Read company updates, product notes, and announcements.",
    "seo_title": "Company News",
    "slug": "company-news",
    "template_handle": "default_blog_category",
    "updated_at": "2026-06-09T12:00:00+05:30"
  }
}

Blog category deleted

EVENT blog_categories/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category is deleted.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  }
}

Blog category metafield value created

EVENT blog_category_metafields/create App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value is created.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  }
}

Blog category metafield value updated

EVENT blog_category_metafields/update App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value changes.

Possible `changed_fields` values

The changed_fields array names exactly which of these changed in this event — use it to skip processing updates your integration doesn't care about.

value

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`previous.definition.id`	`string`	Selectable in the Payload builder
`previous.definition.owner_type`	`string`	Selectable in the Payload builder
`previous.definition.namespace`	`string`	Selectable in the Payload builder
`previous.definition.key`	`string`	Selectable in the Payload builder
`previous.definition.name`	`string`	Selectable in the Payload builder
`previous.definition.description`	`string`	Selectable in the Payload builder
`previous.definition.type`	`string`	Selectable in the Payload builder
`previous.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`previous.definition.max_value_length`	`integer`	Selectable in the Payload builder
`previous.definition.max_list_items`	`integer`	Selectable in the Payload builder
`previous.definition.sort_order`	`integer`	Selectable in the Payload builder
`previous.definition.app_id`	`string`	Selectable in the Payload builder
`previous.definition.app_access`	`string`	Selectable in the Payload builder
`previous.definition.merchant_access`	`string`	Selectable in the Payload builder
`previous.definition.created_at`	`string`	Selectable in the Payload builder
`previous.definition.updated_at`	`string`	Selectable in the Payload builder
`previous.definition.usage_count`	`integer`	Selectable in the Payload builder
`previous.value`	`string`	Selectable in the Payload builder
`previous.display_value`	`string`	Selectable in the Payload builder
`previous.display_value_map`	`object`	Selectable in the Payload builder
`previous.created_at`	`string`	Selectable in the Payload builder
`previous.updated_at`	`string`	Selectable in the Payload builder
`current.definition.id`	`string`	Selectable in the Payload builder
`current.definition.owner_type`	`string`	Selectable in the Payload builder
`current.definition.namespace`	`string`	Selectable in the Payload builder
`current.definition.key`	`string`	Selectable in the Payload builder
`current.definition.name`	`string`	Selectable in the Payload builder
`current.definition.description`	`string`	Selectable in the Payload builder
`current.definition.type`	`string`	Selectable in the Payload builder
`current.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`current.definition.max_value_length`	`integer`	Selectable in the Payload builder
`current.definition.max_list_items`	`integer`	Selectable in the Payload builder
`current.definition.sort_order`	`integer`	Selectable in the Payload builder
`current.definition.app_id`	`string`	Selectable in the Payload builder
`current.definition.app_access`	`string`	Selectable in the Payload builder
`current.definition.merchant_access`	`string`	Selectable in the Payload builder
`current.definition.created_at`	`string`	Selectable in the Payload builder
`current.definition.updated_at`	`string`	Selectable in the Payload builder
`current.definition.usage_count`	`integer`	Selectable in the Payload builder
`current.value`	`string`	Selectable in the Payload builder
`current.display_value`	`string`	Selectable in the Payload builder
`current.display_value_map`	`object`	Selectable in the Payload builder
`current.created_at`	`string`	Selectable in the Payload builder
`current.updated_at`	`string`	Selectable in the Payload builder
`changed_fields`	`array`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "changed_fields": [
    "value"
  ],
  "current": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  },
  "previous": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Company updates",
    "display_value_map": {
      "en": "Company updates"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Company updates"
  }
}

Blog category metafield value deleted

EVENT blog_category_metafields/delete App scope: read_blog Staff permission: blog:write

Fired when a blog category metafield value is deleted, including when its blog category is deleted.

Payload fields

Field	Type	Description
`blog_category.id`	`string`	Always present
`blog_category.name`	`string`	Selectable in the Payload builder
`blog_category.slug`	`string`	Selectable in the Payload builder
`metafield.definition.id`	`string`	Selectable in the Payload builder
`metafield.definition.owner_type`	`string`	Selectable in the Payload builder
`metafield.definition.namespace`	`string`	Selectable in the Payload builder
`metafield.definition.key`	`string`	Selectable in the Payload builder
`metafield.definition.name`	`string`	Selectable in the Payload builder
`metafield.definition.description`	`string`	Selectable in the Payload builder
`metafield.definition.type`	`string`	Selectable in the Payload builder
`metafield.definition.is_translatable`	`boolean`	Selectable in the Payload builder
`metafield.definition.max_value_length`	`integer`	Selectable in the Payload builder
`metafield.definition.max_list_items`	`integer`	Selectable in the Payload builder
`metafield.definition.sort_order`	`integer`	Selectable in the Payload builder
`metafield.definition.app_id`	`string`	Selectable in the Payload builder
`metafield.definition.app_access`	`string`	Selectable in the Payload builder
`metafield.definition.merchant_access`	`string`	Selectable in the Payload builder
`metafield.definition.created_at`	`string`	Selectable in the Payload builder
`metafield.definition.updated_at`	`string`	Selectable in the Payload builder
`metafield.definition.usage_count`	`integer`	Selectable in the Payload builder
`metafield.value`	`string`	Selectable in the Payload builder
`metafield.display_value`	`string`	Selectable in the Payload builder
`metafield.display_value_map`	`object`	Selectable in the Payload builder
`metafield.created_at`	`string`	Selectable in the Payload builder
`metafield.updated_at`	`string`	Selectable in the Payload builder

Payload shape

Sample payload

{
  "blog_category": {
    "id": "5ff7d4ea-3250-4a4d-9d26-07f64d917d31",
    "name": "Company News",
    "slug": "company-news"
  },
  "metafield": {
    "created_at": "2026-06-09T12:00:00+05:30",
    "definition": {
      "app_access": "private",
      "app_id": null,
      "created_at": "2026-06-09T12:00:00+05:30",
      "description": "A short category subtitle.",
      "id": "91ac33ac-1e56-43f9-9280-a541ff762f74",
      "is_translatable": true,
      "key": "subtitle",
      "max_list_items": null,
      "max_value_length": 120,
      "merchant_access": "read_write",
      "name": "Subtitle",
      "namespace": "details",
      "owner_type": "blog_category",
      "sort_order": 0,
      "type": "string",
      "updated_at": "2026-06-09T12:00:00+05:30",
      "usage_count": 1
    },
    "display_value": "Latest company news",
    "display_value_map": {
      "en": "Latest company news"
    },
    "updated_at": "2026-06-09T12:00:00+05:30",
    "value": "Latest company news"
  }
}

Endpoints#

Headers

Query parameters

Headers

Errors

Path parameters

Headers

Errors

Path parameters

Query parameters

Headers

Errors

Path parameters

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Fields#

Webhook events#

Payload fields

Payload fields

Payload fields

Payload fields

Possible changed_fields values

Payload fields

Payload fields

Possible `changed_fields` values