Skip to main content
POST
/
v2
/
_actions
Create Email Action
curl --request POST \
  --url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_actions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "action_timing": "<string>",
  "type": "<string>",
  "webhook": {
    "mandatory": true
  },
  "email": {
    "to": {
      "value": [
        "<string>"
      ]
    },
    "from": "<string>",
    "from_type": "<string>",
    "user_id": "<string>",
    "cc": "<string>",
    "bcc": "<string>",
    "subject": {
      "value": "<string>"
    },
    "body": {
      "value": "<string>"
    },
    "attachment": {},
    "send_static_contect": true,
    "response_message_context": "<string>"
  }
}
'
{
  "ctx_id": "<string>",
  "data": {
    "action_id": "<string>",
    "name": "<string>",
    "type": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contactswing.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorizations

​
Authorization
string
required
Enter your ContactSwing JWT Bearer token.

​
Request Body

​
name
string
required
Action display name. Example: My Email Action
​
description
string
required
Action purpose. Example: Send email when user requests communication
​
action_timing
string
required
When to trigger: "DURING"
​
type
string
required
Action type: "SEND_EMAIL"
​
webhook
object
Webhook configuration (optional)
​
mandatory
boolean
default:"true"
Send static content flag
​
email
object
required
Email configuration object
​
to
object
required
Recipient email addresses
​
value
string[]
required
Enter your message.
​
from
string
required
Sender email. Example: tech.space.me@gmail.com
​
from_type
string
required
Email provider: "gmail"
​
user_id
string
required
User ID for authentication
​
cc
string
CC recipients (comma-separated)
​
bcc
string
BCC recipients (comma-separated)
​
subject
object
required
Email subject line
​
value
string
required
Enter your message.
​
body
object
required
Email content (HTML supported)
​
value
string
“

Hello

”
​
value
string
required
Enter your message.
​
attachment
object
File attachments
​
send_static_contect
boolean
default:"true"
Send static content flag
​
response_message_context
string
Response message context Example: I’ve just sent you an email. Please let me know if you received it.

​
Response

201 Created - Email action created successfully
​
ctx_id
string
Request context ID
​
data
object
​
action_id
string
New email action ID
​
name
string
Action name
​
type
string
”SEND_EMAIL”
400 Bad Request - Invalid email configuration 401 Unauthorized - Invalid token