Messaging
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
PATCH |
List all messaging templates
Required API key scopes
hog_flow:readQuery parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /messaging_templatesExample response
Status 200
RESPONSE
Create messaging templates
Required API key scopes
hog_flow:writeRequest parameters
- namestring
- descriptionstring
- content
- typestring
- message_categorystringnull
- deletedboolean
Response
Example request
POST /api /projects /:project_id /messaging_templatesExample response
Status 201
RESPONSE
Retrieve messaging templates
Required API key scopes
hog_flow:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /messaging_templates /:idExample response
Status 200
RESPONSE
Update messaging templates
Required API key scopes
hog_flow:writePath parameters
- idstring
Request parameters
- namestring
- descriptionstring
- content
- typestring
- message_categorystringnull
- deletedboolean
Response
Example request
PATCH /api /projects /:project_id /messaging_templates /:idExample response
Status 200
RESPONSE
Delete messaging templates
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
hog_flow:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /messaging_templates /:idExample response
Status 405 No response body
Update messaging templates design
Required API key scopes
hog_flow:writePath parameters
- idstring
Request parameters
- operationsarray
Response
Example request
PATCH /api /projects /:project_id /messaging_templates /:id /designExample response
Status 200
RESPONSE