kustomer-client
Preparing search index...
KustomerApi
redactMessage
Function redactMessage
redactMessage
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
RedactMessageData
,
ThrowOnError
>
,
)
:
RequestResult
<
{
data
:
{
attributes
:
{
meta
?:
string
;
preview
:
string
}
;
id
:
string
;
relationships
:
{
attachments
?:
{
data
?:
{
id
:
string
;
type
:
string
}
;
links
?:
{
self
:
string
}
;
}
[]
;
conversation
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
createdBy
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
customer
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
message
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Redact a message Redacts a message.
Any one of the following roles is required for this endpoint:
Legacy Role
Equivalent Permission Set Role
org.admin.message.write
org.permission.message_redaction.create
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
RedactMessageData
,
ThrowOnError
>
Returns
RequestResult
<
{
data
:
{
attributes
:
{
meta
?:
string
;
preview
:
string
}
;
id
:
string
;
relationships
:
{
attachments
?:
{
data
?:
{
id
:
string
;
type
:
string
}
;
links
?:
{
self
:
string
}
;
}
[]
;
conversation
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
createdBy
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
customer
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
message
?:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
;
}
;
org
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
kustomer-client
Loading...
Redact a message Redacts a message.
Any one of the following roles is required for this endpoint: