REST API Reference for Launch Cloud Service

Update a channel

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel/{id}

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Supported Media Types

application/json

Root Schema : ChannelOracle

Type: object

Title: ChannelOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
applicationName: string

name of the external application.
channelType: string

?Channel type such as sales or trouble ticket raising?
created: string (date-time)

Date and time of the channel creation.
createdBy: string

name of the person who created the channel.
description: string

Description of channel.
externalId: string

id of the external application.
href: string

Hypertext Reference of the channel.
id: string

Maximum Length: 30

Unique identifier of the channel.
lastUpdate: string (date-time)

Latest update date of channel.
lastUpdatedBy: string

name of the person who updated the channel.
lifecycleStatus: string

Status of channel
name(required): string

Name of channel.
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Channel version
versionState: number

Version state of the channel.

{
    "title":"ChannelOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of channel."
        },
        "description":{
            "type":"string",
            "description":"Description of channel."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the channel."
        },
        "channelType":{
            "type":"string",
            "description":"?Channel type such as sales or trouble ticket raising?"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of channel."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of channel"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Channel version"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the channel creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the channel."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the channel."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the channel."
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application."
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : ChannelOracle

Type: object

Title: ChannelOracle

Show Source

@baseType: string

Immediate base (class) type of the object
@schemaLocation: string

A link to the schema describing this object
@type(required): string

Indicates the type of resource.
applicationName: string

name of the external application.
channelType: string

?Channel type such as sales or trouble ticket raising?
created: string (date-time)

Date and time of the channel creation.
createdBy: string

name of the person who created the channel.
description: string

Description of channel.
externalId: string

id of the external application.
href: string

Hypertext Reference of the channel.
id: string

Maximum Length: 30

Unique identifier of the channel.
lastUpdate: string (date-time)

Latest update date of channel.
lastUpdatedBy: string

name of the person who updated the channel.
lifecycleStatus: string

Status of channel
name(required): string

Name of channel.
project: object ProjectRef

Title: ProjectRef

Project Reference
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid
version: string

Channel version
versionState: number

Version state of the channel.

{
    "title":"ChannelOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"Unique identifier of the channel."
        },
        "name":{
            "type":"string",
            "description":"Name of channel."
        },
        "description":{
            "type":"string",
            "description":"Description of channel."
        },
        "href":{
            "type":"string",
            "description":"Hypertext Reference of the channel."
        },
        "channelType":{
            "type":"string",
            "description":"?Channel type such as sales or trouble ticket raising?"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Latest update date of channel."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of channel"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the type of resource."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the object"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this object"
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "version":{
            "type":"string",
            "description":"Channel version"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the channel creation."
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created the channel."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated the channel."
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the channel."
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application."
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application."
        }
    },
    "required":[
        "name",
        "@type"
    ]
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : TimePeriod

Type: object

Title: TimePeriod

The period for which the productOffering is valid

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following example shows how to update a channel by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u username:password -X PATCH https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel -H 'Content-Type: application/json' -D @update_channel.json | json_pp

Example of Request Body

The following shows the contents of the request body in JSON format.

{
    "id": "CH-3109730861-1758272609752",
    "description": "Channel Test - Update"
}

Example of Response Body

The following shows the contents of the response body in JSON format.

{
    "id": "CH-3109730861-1758272609752",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/channel/CH-3109730861-1758272609752",
    "name": "channel-new1",
    "description": "Channel Test - Update",
    "validFor": {
        "startDateTime": "2025-09-12T00:00:00.000Z",
        "endDateTime": "2025-10-09T00:00:00.000Z"
    },
    "@type": "ChannelOracle",
    "version": "1.0",
    "created": "2025-09-19T09:03:41.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-10-22T05:34:00.000Z",
    "lastUpdatedBy": "booth",
    "lifecycleStatus": "In design",
    "project": {
        "id": "P-2341675923-1758270057151",
        "name": "Retire Init3",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-2341675923-1758270057151",
        "version": "1.0",
        "@referredType": "ProjectOracle",
        "@type": "ProjectRef"
    }
}