Jump to

• Request
• Response

Update a campaign sales content

patch

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents/{SalesContentId}

Request

Path Parameters

• CampaignNumber(required): string
  The alternate key identifier of the campaign.
• SalesContentId(required): integer(int64)
  The unique identifier of the sales content.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ContentItemId: string
  Title: Content ID

  Maximum Length: 64

  The internal content item identifier from the source system.
• ContentItemName: string
  Title: Content Name

  Maximum Length: 4000

  The name of the sales content item.
• ContentSourceSystem: string
  Maximum Length: 50

  Default Value: OCE

  Indicates from where the content item is sourced.
• DeletedInSourceFlag: boolean
  Title: Content Deleted in Source

  Maximum Length: 1

  Default Value: false

  Indicates whether referred sales content item is deleted in source system.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Indicates the sequence in which the sales content should appear in a page.
• ParentObjectType: string
  Maximum Length: 128

  The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.
• PublicContentItemId: string
  Title: Public Content ID

  Maximum Length: 64

  The public content item identifier from the source system.
• PublicContentItemName: string
  Title: Public Content Name

  Maximum Length: 4000

  The name of the public sales content item.
• PublicCustomerName: string
  Title: Customer Name

  Maximum Length: 4000

  The name of the customer for which the public content was published.
• PublicPublishedDate: string (date-time)
  Title: Publish Date

  The date on which the public content item was published.
• PublicStoryLink: string
  Title: Public URL

  Maximum Length: 4000

  The link of the public content item.

{
    "type":"object",
    "properties":{
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false
        },
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE"
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : campaigns-SalesContents-item-response

Type: object

Show Source

• CanDelete: string
  Read Only: true

  Default Value: Y

  Indicates whether user can delete the content item or not.
• CanUpdate: string
  Read Only: true

  Default Value: Y

  Indicates whether user can update the content item or not.
• ContentItemId: string
  Title: Content ID

  Maximum Length: 64

  The internal content item identifier from the source system.
• ContentItemName: string
  Title: Content Name

  Maximum Length: 4000

  The name of the sales content item.
• ContentItemType: string
  Read Only: true

  Indicates the type of content, for example pdf, png, and so on.
• ContentSourceSystem: string
  Maximum Length: 50

  Default Value: OCE

  Indicates from where the content item is sourced.
• DeletedInSourceFlag: boolean
  Title: Content Deleted in Source

  Maximum Length: 1

  Default Value: false

  Indicates whether referred sales content item is deleted in source system.
• DisplaySequence: integer (int32)
  Title: Display Sequence

  Indicates the sequence in which the sales content should appear in a page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentObjectId: integer (int64)
  Title: Parent Object ID

  The unique identifier of the object associated to the sales content row.
• ParentObjectType: string
  Maximum Length: 128

  The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.
• PublicContentItemId: string
  Title: Public Content ID

  Maximum Length: 64

  The public content item identifier from the source system.
• PublicContentItemName: string
  Title: Public Content Name

  Maximum Length: 4000

  The name of the public sales content item.
• PublicCustomerName: string
  Title: Customer Name

  Maximum Length: 4000

  The name of the customer for which the public content was published.
• PublicPublishedDate: string (date-time)
  Title: Publish Date

  The date on which the public content item was published.
• PublicStoryLink: string
  Title: Public URL

  Maximum Length: 4000

  The link of the public content item.
• SalesContentId: integer (int64)
  Title: Sales Content ID

  Read Only: true

  The unique identifier of the sales content.

{
    "type":"object",
    "properties":{
        "CanDelete":{
            "type":"string",
            "description":"Indicates whether user can delete the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CanUpdate":{
            "type":"string",
            "description":"Indicates whether user can update the content item or not.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentItemId":{
            "title":"Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The internal content item identifier from the source system.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemName":{
            "title":"Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the sales content item.",
            "nullable":false,
            "x-queryable":true
        },
        "ContentItemType":{
            "type":"string",
            "description":"Indicates the type of content, for example pdf, png, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentSourceSystem":{
            "maxLength":50,
            "type":"string",
            "description":"Indicates from where the content item is sourced.",
            "nullable":true,
            "default":"OCE",
            "x-queryable":true
        },
        "DeletedInSourceFlag":{
            "title":"Content Deleted in Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether referred sales content item is deleted in source system.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the sales content should appear in a page.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParentObjectId":{
            "title":"Parent Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated to the sales content row.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentObjectType":{
            "maxLength":128,
            "type":"string",
            "description":"The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "PublicContentItemId":{
            "title":"Public Content ID",
            "maxLength":64,
            "type":"string",
            "description":"The public content item identifier from the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicContentItemName":{
            "title":"Public Content Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the public sales content item.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicCustomerName":{
            "title":"Customer Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the customer for which the public content was published.",
            "nullable":true,
            "x-queryable":true
        },
        "PublicPublishedDate":{
            "title":"Publish Date",
            "type":"string",
            "description":"The date on which the public content item was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicStoryLink":{
            "title":"Public URL",
            "maxLength":4000,
            "type":"string",
            "description":"The link of the public content item.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesContentId":{
            "title":"Sales Content ID",
            "type":"integer",
            "description":"The unique identifier of the sales content.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top