REST API Reference for Launch Cloud Service

Create or update a market segment

put

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

Creates or updates the market segment with the specified ID.

Request

Path Parameters

id(required): string

The ID of the resource item.

Supported Media Types

application/json

Root Schema : MarketSegmentOracle

Type: object

Title: MarketSegmentOracle

The market segment resource.

Show Source

@baseType: string

The base type of the market segment.
@schemaLocation: string

The URI of the schema that defines the market segment.
@type(required): string

The class type of the market segment.
applicationName: string

The name of the application associated with the market segment.
created: string (date-time)

The date and time of the market segment creation.
createdBy: string

The name of the person who created the market segment.
description: string

The description of market segment.
externalId: string

The ID of the external associated with the market segment.
href: string

The hyperlink reference to the market segment.
id: string

Maximum Length: 30

The ID of the market segment.
lastUpdate: string (date-time)

The date and time when the market segment was last updated.
lastUpdatedBy: string

The name of the person who updated the market segment.
lifecycleStatus: string

The status of the market segment.
name(required): string

The name of the market segment.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The market segment version.
versionState: number

The version state of the market segment.

{
    "title":"MarketSegmentOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the market segment."
        },
        "name":{
            "type":"string",
            "description":"The name of the market segment."
        },
        "description":{
            "type":"string",
            "description":"The description of market segment."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the market segment."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the market segment was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the market segment."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the market segment is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the market segment."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the market segment."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the market segment."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The market segment."
        },
        "version":{
            "type":"string",
            "description":"The market segment version."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the market segment creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created the market segment."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated the market segment."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the market segment."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the market segment."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the market segment."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "description":"The market segment resource."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The 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)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The market segment was created or updated successfully.

Root Schema : MarketSegmentOracle

Type: object

Title: MarketSegmentOracle

The market segment resource.

Show Source

@baseType: string

The base type of the market segment.
@schemaLocation: string

The URI of the schema that defines the market segment.
@type(required): string

The class type of the market segment.
applicationName: string

The name of the application associated with the market segment.
created: string (date-time)

The date and time of the market segment creation.
createdBy: string

The name of the person who created the market segment.
description: string

The description of market segment.
externalId: string

The ID of the external associated with the market segment.
href: string

The hyperlink reference to the market segment.
id: string

Maximum Length: 30

The ID of the market segment.
lastUpdate: string (date-time)

The date and time when the market segment was last updated.
lastUpdatedBy: string

The name of the person who updated the market segment.
lifecycleStatus: string

The status of the market segment.
name(required): string

The name of the market segment.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
validFor: object TimePeriod

Title: TimePeriod

The period for which the productOffering is valid.
version: string

The market segment version.
versionState: number

The version state of the market segment.

{
    "title":"MarketSegmentOracle",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":30,
            "description":"The ID of the market segment."
        },
        "name":{
            "type":"string",
            "description":"The name of the market segment."
        },
        "description":{
            "type":"string",
            "description":"The description of market segment."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the market segment."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the market segment was last updated."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the market segment."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod",
            "description":"The period for which the market segment is valid."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the market segment."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the market segment."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the market segment."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The market segment."
        },
        "version":{
            "type":"string",
            "description":"The market segment version."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of the market segment creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created the market segment."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated the market segment."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the market segment."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the market segment."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the market segment."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "description":"The market segment resource."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The 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)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "title":"TimePeriod",
    "description":"The period for which the productOffering is valid.",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to create or update a market segment by submitting a PUT request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

{
  "id": "MS-3109730864",
  "name": "Students",
  "description": "Students Segment",
  "@type": "PlaceOracle",
  "validFor": {
    "startDateTime": "2025-09-12T00:00:00.000Z",
    "endDateTime": "2025-10-09T00:00:00.000Z"
  },
  "project": {
    "id": "P-2341675923-1758270057151",
    "name": "Retire Init3",
    "@type": "ProjectRef",
    "@referredType": "ProjectOracle"
  },
  "version": "1.0",
  "lifecycleStatus": "In design"
  
}

Example of Response Body

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

{
    "id": "MS-3109730864",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/marketSegment/MS-3109730864",
    "name": "Students",
    "description": "Students Segment",
    "lifecycleStatus": "In design",
    "lastUpdate": "2025-10-23T08:09:44.080Z",
    "validFor": {
        "startDateTime": "2025-09-12T00:00:00.000Z",
        "endDateTime": "2025-10-09T00:00:00.000Z"
    },
    "version": "1.0",
    "@type": "MarketSegmentOracle",
    "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"
    },
    "lastUpdatedBy": "booth",
    "created": "2025-10-23T08:09:44.000Z",
    "createdBy": "booth",
    "versionState": 0
}