REST API v1

Saved replies

Base URL https://your-site.com/wp-json/cliedesk-api/v1. See the overview for keys, scopes and errors.

List saved replies

GET /saved-replies

Scope saved_replies:read · Cost 1

Name	Type	Description
`conversation_id`	query · string
`mode`	query · string	One of: new, reply, note, bulk
`q`	query · string
`status`	query · string	One of: active, inactive, archived, all
`category`	query · string
`sort`	query · string	One of: manual, name, usage, recent, relevance
`limit`	query · integer

POST /saved-replies

Scope saved_replies:write · Cost 2

Name	Type	Description
`Idempotency-Key`	header · string

Name	Type	Description
`name` required	string
`shortcut`	string
`category`	string
`scope`	string	One of: personal, team, shared
`status`	string	One of: active, inactive, archived
`default_language`	string
`note_html`	string
`steps`	array of object
`availability`	object
`variants`	array of object
`team_ids`	array of string
`product_ids`	array of string
`sort`	integer

POST /saved-replies/render

Scope saved_replies:read · Cost 2

Name	Type	Description
`Idempotency-Key`	header · string

Name	Type	Description
`ids` required	array of integer
`conversation_id` required	string

GET /saved-replies/{id}

Scope saved_replies:read · Cost 1

Name	Type	Description
`id` required	path · string

PATCH /saved-replies/{id}

Scope saved_replies:write · Cost 2

Name	Type	Description
`id` required	path · string
`Idempotency-Key`	header · string

Name	Type	Description
`name`	string
`shortcut`	string
`category`	string
`scope`	string	One of: personal, team, shared
`status`	string	One of: active, inactive, archived
`default_language`	string
`note_html`	string
`steps`	array of object
`availability`	object
`variants`	array of object
`team_ids`	array of string
`product_ids`	array of string
`sort`	integer

DELETE /saved-replies/{id}

Scope saved_replies:write · Cost 2

Name	Type	Description
`id` required	path · string
`Idempotency-Key`	header · string

Name	Type	Description
`confirm`	boolean