MobileApp

Perform Custom Template Action

Changed on

Function: perform_custom_template_action

Type: API Endpoint (POST)

Purpose:
Queues a custom template action.

Headers:

  • Customer_Key (str, required): The customer key.
  • User_Code (str, required): The user code.

Request Body: A JSON object containing the action data.

Response: A JSON response containing the result of the action.

Exceptions:

  • HTTPException: If any exception occurs during the process, it raises an HTTPException with a 500 status code and the exception message.

Action Data Request Body: { "template_code": "string, required, the template code", "action_type": "integer, required, the action type (0 = custom send, 1 = row send, 2 = direct row send)", "email_to": "string, optional, the email addresses to send to", "email_cc": "string, optional, the email addresses to send CC to", "email_bcc": "string, optional, the email addresses to send BCC to", "sequence": "string, optional, the sequence to send to", "recipient_row_id": "integer, optional, the recipient row ID to send to" }

post/api/MobileApp/templates/custom_trigger

Request

Headers

Customer-Keystring required
User-Codestring required

Request body

template_codestring required
action_typeinteger required
email_tostring[] nullable
email_ccstring[] nullable
email_bccstring[] nullable
recipient_row_idinteger nullable
sequenceinteger nullable

Response

Successful Response

unknown required

Changes