patch /api/channels/{id}
Updates the Channel resource.
Partially updates a channel. The body is a JSON Merge Patch document: include only the fields you want to change - for example to rename it, change its status, or update the products assigned to it.
Name Type Required Description Flowkiwi-Localestring- Specifies the locale for properties that support localization. If not provided, the default locale will be used.
Path parameters Name Type Required Description idstringrequired Channel identifier
Request body Property Type Required Description namestring | null- The display name of the channel. productsstring[]- A list of Product IRIs published to the channel. Requires the products:read scope. Returned empty when the scope is missing. status"/api/statuses/DRAFT" | "/api/statuses/ACTIVE" | "/api/statuses/ARCHIVED"- The status of the channel.
Response 200 - Channel resource updated
Format JSON-LD JSON Property Type Required Description @contextstring | object- @idstringrequired @typestringrequired createdAtstring- The date and time when the resource was created (ISO 8601 format). idstring- The resource's unique identifier (UUID). namestring | null- This property supports translations. productsstring[]- A list of Product IRIs published to the channel. Requires the products:read scope. Returned empty when the scope is missing. status"/api/statuses/DRAFT" | "/api/statuses/ACTIVE" | "/api/statuses/ARCHIVED"- The status of the channel. updatedAtstring- The date and time when the resource was last modified (ISO 8601 format).
Property Type Required Description createdAtstring- The date and time when the resource was created (ISO 8601 format). idstring- The resource's unique identifier (UUID). namestring | null- This property supports translations. productsstring[]- A list of Product IRIs published to the channel. Requires the products:read scope. Returned empty when the scope is missing. status"/api/statuses/DRAFT" | "/api/statuses/ACTIVE" | "/api/statuses/ARCHIVED"- The status of the channel. updatedAtstring- The date and time when the resource was last modified (ISO 8601 format).
Errors 400 - Invalid input
Format JSON-LD JSON Property Type Required Description @contextstring | object- @idstringrequired @typestringrequired codestring- Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. descriptionstring | null- detailstring | null- A human-readable explanation specific to this occurrence of the problem. instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. messagestring- End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. slugstring- Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. statusinteger | null- titlestring | null- A short, human-readable summary of the problem. For a catalogued error it repeats the slug. typestring- A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
Property Type Required Description codestring- Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. detailstring | null- A human-readable explanation specific to this occurrence of the problem. instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. messagestring- End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. slugstring- Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. statusinteger | null- titlestring | null- A short, human-readable summary of the problem. For a catalogued error it repeats the slug. typestring- A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
403 - Access denied. The caller is missing one or more permissions required for this operation.
Content-Type: application/problem+json
Property Type Required Description @contextstring | object- @idstringrequired @typestringrequired detailstring- missingPermissionsstring[]- Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. statusinteger- titlestring- typestring-
404 - Not found
Format JSON-LD JSON Property Type Required Description @contextstring | object- @idstringrequired @typestringrequired codestring- Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. descriptionstring | null- detailstring | null- A human-readable explanation specific to this occurrence of the problem. instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. messagestring- End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. slugstring- Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. statusinteger | null- titlestring | null- A short, human-readable summary of the problem. For a catalogued error it repeats the slug. typestring- A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
Property Type Required Description codestring- Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. detailstring | null- A human-readable explanation specific to this occurrence of the problem. instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. messagestring- End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. slugstring- Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. statusinteger | null- titlestring | null- A short, human-readable summary of the problem. For a catalogued error it repeats the slug. typestring- A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.
422 - An error occurred
Format JSON-LD JSON Property Type Required Description @contextstring | object- @idstringrequired @typestringrequired descriptionstring- detailstring- instancestring | null- statusinteger- titlestring | null- typestring- violationsobject[]- Show violations fields Property Type Required Description codestring- The code of the violation hintstring- An extra hint to understand the violation messagestringrequired The message associated with the violation parametersobject- Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payloadobject- The serialized payload of the violation propertyPathstringrequired The property path of the violation slugstring- Stable centralized error-code slug for this violation (see /api/error-codes).
Property Type Required Description detailstring- instancestring | null- statusinteger- titlestring | null- typestring- violationsobject[]- Show violations fields Property Type Required Description codestring- The code of the violation hintstring- An extra hint to understand the violation messagestringrequired The message associated with the violation parametersobject- Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payloadobject- The serialized payload of the violation propertyPathstringrequired The property path of the violation slugstring- Stable centralized error-code slug for this violation (see /api/error-codes).
