Perform Custom Template Action
Changed onFunction: 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" }
Request
- Base URLhttps://api.leapsurgebi.com (the document declares no server; this is the origin it was published from)
- AuthOAuth 2PasswordToken URL/auth/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Request body
Response
Successful Response
Changes
- info
endpoint added
- info