Jump to

• Request
• Response

Update a Slack application

patch

/hcmRestApi/resources/11.13.18.05/communicateUISlackApps/{CampSlackAPPId}

Request

Path Parameters

• CampSlackAPPId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• BackgroundColor: string
  Maximum Length: 20

  Specifies the background color for the Slack application interface. This color enhances the visual appearance of the application in Slack.
• CampSlackAPPId: integer (int64)
  Unique identifier for the Slack application associated with the campaign.
• installedSlackApps: array Installed Slack Application
  Title: Installed Slack Application

  The installedSlackApps resource provides access to Slack application installations.
• ObjectVersionNumber: integer (int32)
  Version number of the Slack application object. This value helps track changes to the object.
• SlackAPPDescription: string
  Maximum Length: 1000

  Description of the Slack application used for campaign communication. This field provides details about the application's purpose and functionality.
• SlackAPPLongDescription: string
  Maximum Length: 4000

  Detailed description of the Slack application used for campaign communication. This field provides additional context or instructions about the Slack application integration.
• SlackAPPName(required): string
  Maximum Length: 500

  Name of the Slack application used for communication in the campaign.
• Status(required): string
  Maximum Length: 30

  Indicates the current status of the Slack application. Valid values are Active and Inactive. Default is Inactive.

{
    "required":[
        "SlackAPPName",
        "Status"
    ],
    "type":"object",
    "properties":{
        "BackgroundColor":{
            "maxLength":20,
            "type":"string",
            "description":"Specifies the background color for the Slack application interface. This color enhances the visual appearance of the application in Slack.",
            "nullable":true
        },
        "CampSlackAPPId":{
            "type":"integer",
            "description":"Unique identifier for the Slack application associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the Slack application object. This value helps track changes to the object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SlackAPPDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the Slack application used for campaign communication. This field provides details about the application's purpose and functionality.",
            "nullable":true
        },
        "SlackAPPLongDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Detailed description of the Slack application used for campaign communication. This field provides additional context or instructions about the Slack application integration.",
            "nullable":true
        },
        "SlackAPPName":{
            "maxLength":500,
            "type":"string",
            "description":"Name of the Slack application used for communication in the campaign.",
            "nullable":false
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the Slack application. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":false
        },
        "installedSlackApps":{
            "title":"Installed Slack Application",
            "type":"array",
            "description":"The installedSlackApps resource provides access to Slack application installations.",
            "items":{
                "$ref":"#/components/schemas/communicateUISlackApps-installedSlackApps-item-patch-request"
            }
        }
    }
}

Nested Schema : Installed Slack Application

Type: array

Title: Installed Slack Application

The installedSlackApps resource provides access to Slack application installations.

Show Source

• Array of: object communicateUISlackApps-installedSlackApps-item-patch-request

{
    "title":"Installed Slack Application",
    "type":"array",
    "description":"The installedSlackApps resource provides access to Slack application installations.",
    "items":{
        "$ref":"#/components/schemas/communicateUISlackApps-installedSlackApps-item-patch-request"
    }
}

Nested Schema : communicateUISlackApps-installedSlackApps-item-patch-request

Type: object

Show Source

• CampSlackAPPId: integer (int64)
  Unique identifier of the Slack application instance associated with the campaign.
• CampSlackAPPInstId: integer (int64)
  Unique identifier of the Slack application instance in the campaign.
• CampSlackWkspId: integer (int64)
  Unique identifier of the Slack workspace associated with the campaign.
• OauthAuthorizeURL: string
  Maximum Length: 2048

  URL for OAuth authorization to integrate with Slack.
• Scopes: string
  Maximum Length: 1024

  List of permissions or access rights granted to the Slack application. This defines what the application can do within the Slack workspace.
• SlackAPPId: string
  Maximum Length: 50

  Unique identifier of the Slack application instance.
• Status: string
  Maximum Length: 30

  Indicates the current status of the installed Slack application. Valid values are Active and Inactive. Default is Inactive.

{
    "type":"object",
    "properties":{
        "CampSlackAPPId":{
            "type":"integer",
            "description":"Unique identifier of the Slack application instance associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampSlackAPPInstId":{
            "type":"integer",
            "description":"Unique identifier of the Slack application instance in the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampSlackWkspId":{
            "type":"integer",
            "description":"Unique identifier of the Slack workspace associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OauthAuthorizeURL":{
            "maxLength":2048,
            "type":"string",
            "description":"URL for OAuth authorization to integrate with Slack.",
            "nullable":true
        },
        "Scopes":{
            "maxLength":1024,
            "type":"string",
            "description":"List of permissions or access rights granted to the Slack application. This defines what the application can do within the Slack workspace.",
            "nullable":true
        },
        "SlackAPPId":{
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier of the Slack application instance.",
            "nullable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the installed Slack application. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":false
        }
    }
}

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 : communicateUISlackApps-item-response

Type: object

Show Source

• BackgroundColor: string
  Maximum Length: 20

  Specifies the background color for the Slack application interface. This color enhances the visual appearance of the application in Slack.
• CampSlackAPPId: integer (int64)
  Unique identifier for the Slack application associated with the campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Identifies the user who created the Slack application in the campaign.
• CreationDate: string (date-time)
  Read Only: true

  Creation date of the Slack application in the campaign communication UI.
• installedSlackApps: array Installed Slack Application
  Title: Installed Slack Application

  The installedSlackApps resource provides access to Slack application installations.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time the Slack application was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the Slack application.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last update login identifier for the Slack application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Version number of the Slack application object. This value helps track changes to the object.
• SlackAPPDescription: string
  Maximum Length: 1000

  Description of the Slack application used for campaign communication. This field provides details about the application's purpose and functionality.
• SlackAPPLongDescription: string
  Maximum Length: 4000

  Detailed description of the Slack application used for campaign communication. This field provides additional context or instructions about the Slack application integration.
• SlackAPPName: string
  Maximum Length: 500

  Name of the Slack application used for communication in the campaign.
• Status: string
  Maximum Length: 30

  Indicates the current status of the Slack application. Valid values are Active and Inactive. Default is Inactive.

{
    "type":"object",
    "properties":{
        "BackgroundColor":{
            "maxLength":20,
            "type":"string",
            "description":"Specifies the background color for the Slack application interface. This color enhances the visual appearance of the application in Slack.",
            "nullable":true,
            "x-queryable":true
        },
        "CampSlackAPPId":{
            "type":"integer",
            "description":"Unique identifier for the Slack application associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user who created the Slack application in the campaign.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the Slack application in the campaign communication UI.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time the Slack application was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last update login identifier for the Slack application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the Slack application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the Slack application object. This value helps track changes to the object.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SlackAPPDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the Slack application used for campaign communication. This field provides details about the application's purpose and functionality.",
            "nullable":true,
            "x-queryable":true
        },
        "SlackAPPLongDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Detailed description of the Slack application used for campaign communication. This field provides additional context or instructions about the Slack application integration.",
            "nullable":true,
            "x-queryable":true
        },
        "SlackAPPName":{
            "maxLength":500,
            "type":"string",
            "description":"Name of the Slack application used for communication in the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the Slack application. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "installedSlackApps":{
            "title":"Installed Slack Application",
            "type":"array",
            "description":"The installedSlackApps resource provides access to Slack application installations.",
            "items":{
                "$ref":"#/components/schemas/communicateUISlackApps-installedSlackApps-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Installed Slack Application

Type: array

Title: Installed Slack Application

The installedSlackApps resource provides access to Slack application installations.

Show Source

• Array of: object communicateUISlackApps-installedSlackApps-item-response

{
    "title":"Installed Slack Application",
    "type":"array",
    "description":"The installedSlackApps resource provides access to Slack application installations.",
    "items":{
        "$ref":"#/components/schemas/communicateUISlackApps-installedSlackApps-item-response"
    }
}

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 : communicateUISlackApps-installedSlackApps-item-response

Type: object

Show Source

• CampSlackAPPId: integer (int64)
  Unique identifier of the Slack application instance associated with the campaign.
• CampSlackAPPInstId: integer (int64)
  Unique identifier of the Slack application instance in the campaign.
• CampSlackWkspId: integer (int64)
  Unique identifier of the Slack workspace associated with the campaign.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OauthAuthorizeURL: string
  Maximum Length: 2048

  URL for OAuth authorization to integrate with Slack.
• Scopes: string
  Maximum Length: 1024

  List of permissions or access rights granted to the Slack application. This defines what the application can do within the Slack workspace.
• SlackAPPId: string
  Maximum Length: 50

  Unique identifier of the Slack application instance.
• SlackWkspId: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the Slack workspace associated with the installed application.
• SlackWkspName: string
  Read Only: true

  Maximum Length: 255

  Name of the Slack workspace where the application is installed.
• SlackWkspURL: string
  Read Only: true

  Maximum Length: 255

  URL of the Slack workspace where the application is installed.
• Status: string
  Maximum Length: 30

  Indicates the current status of the installed Slack application. Valid values are Active and Inactive. Default is Inactive.

{
    "type":"object",
    "properties":{
        "CampSlackAPPId":{
            "type":"integer",
            "description":"Unique identifier of the Slack application instance associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampSlackAPPInstId":{
            "type":"integer",
            "description":"Unique identifier of the Slack application instance in the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampSlackWkspId":{
            "type":"integer",
            "description":"Unique identifier of the Slack workspace associated with the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OauthAuthorizeURL":{
            "maxLength":2048,
            "type":"string",
            "description":"URL for OAuth authorization to integrate with Slack.",
            "nullable":true,
            "x-queryable":true
        },
        "Scopes":{
            "maxLength":1024,
            "type":"string",
            "description":"List of permissions or access rights granted to the Slack application. This defines what the application can do within the Slack workspace.",
            "nullable":true,
            "x-queryable":true
        },
        "SlackAPPId":{
            "maxLength":50,
            "type":"string",
            "description":"Unique identifier of the Slack application instance.",
            "nullable":true,
            "x-queryable":true
        },
        "SlackWkspId":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the Slack workspace associated with the installed application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SlackWkspName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the Slack workspace where the application is installed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SlackWkspURL":{
            "maxLength":255,
            "type":"string",
            "description":"URL of the Slack workspace where the application is installed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the current status of the installed Slack application. Valid values are Active and Inactive. Default is Inactive.",
            "nullable":false,
            "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."
        }
    }
}

Links

installedSlackApps

Operation: /hcmRestApi/resources/11.13.18.05/communicateUISlackApps/{CampSlackAPPId}/child/installedSlackApps

Parameters:

• CampSlackAPPId: $request.path.CampSlackAPPId

The installedSlackApps resource provides access to Slack application installations.

Back to Top