Skip to main content
POST
/
api
/
v1
/
sender-profiles
Create Sender Profile
curl --request POST \
  --url https://api.example.com/api/v1/sender-profiles/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "profile_name": "<string>",
  "sender_data": {},
  "description": "<string>",
  "is_default": false
}
'
{
  "user_id": "<string>",
  "profile_name": "<string>",
  "sender_data": {
    "data": {}
  },
  "id": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "usage_count": 0,
  "is_default": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request model for creating a sender profile.

​
profile_name
string
required

User-friendly name for this profile

Required string length: 1 - 100
​
sender_data
Sender Data · object
required

The sender data as a dictionary with any fields

​
description
string | null

Optional description of when/how to use this profile

Maximum string length: 500
​
is_default
boolean
default:false

Whether this should be the default profile

Response

Successful Response

Sender profile model for storing reusable sender configurations.

This model stores a named profile containing DynamicSenderData, which can have ANY arbitrary fields. There is no predefined schema for the sender data.

Examples of valid sender data:

  • {"full_name": "John", "company": "TechCorp", "role": "Sales"}
  • {"sender_name": "Jane", "brand": "AI Solutions", "linkedin": "jane-doe"}
  • {"name": "Bob", "agency": "Marketing Pro", "phone": "+1234", "timezone": "EST"}
  • Any other combination of fields the user needs
​
user_id
string
required

User ID who owns this profile

​
profile_name
string
required

User-friendly name for this profile (e.g., 'Sales Team Profile', 'Personal Brand')

Required string length: 1 - 100
​
sender_data
DynamicSenderData · object
required

The actual sender data with arbitrary fields

​
id
string | null

Unique profile identifier

​
description
string | null

Optional description of when/how to use this profile

Maximum string length: 500
​
created_at
string<date-time> | null

Profile creation timestamp

​
updated_at
string<date-time> | null

Last update timestamp

​
usage_count
integer
default:0

Number of times this profile has been used

​
is_default
boolean
default:false

Whether this is the default profile