GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home

Create or update Rule

put
https://api.talkdeskapp.com/automated-notifications/rules

Creates or updates a Rule.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

automated-notifications-management:write

Query Params
string
required
length ≥ 1

The value of the event type to match with Events.

Body Params
string
length ≥ 1

The id of the Rule.

string
required
length ≥ 1

The name of the Rule.

string
enum
required
length ≥ 1

The action type triggered by this Rule.

Allowed:
object
required
string
enum
required
length ≥ 1

The trigger type the rule should be triggered on.

Allowed:
trigger_on_offset
object

The time interval. This interval refers to a time offset composed of a time-unit type and value (e.g. type=HOUR, value=2 refers to two hour past a certain date).

recurrence
object

The recurrency configuration of an event.

boolean
required

Should discard event notifications out of available interval.

boolean
required

Include the conversation history in the Rule.

string

The Touchpoint id for escalation.

calendar_preferences
array of objects
calendar_preferences
topic_ids
array of strings
topic_ids
Responses

Updated 2 months ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago