System key | Purpose |
---|---|
$email |
User email |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
double_subscribe |
Optional[boolean] | Resubscribes unsubscribed user in case $email property is updated. Default: false |
source |
Optional[Dict] | Sets source of received $email and $phone properties. |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify Email
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$email", "value": "test@email.io"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify Email
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$email", "value": "test@email.io"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$name |
User first name |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify Name
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$name", "value": "Test"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify Name
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$name", "value": "Test"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$phone |
User phone number |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
source |
Optional[Dict] | Sets source of received $email and $phone properties. |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify Phone
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$phone", "value": "123456789"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify Phone
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$phone", "value": "123456789"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$demo_request_page |
URL of demo form submission |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify Demo request page
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$demo_request_page", "value": "https://some.page"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify Demo request page
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$demo_request_page", "value": "https://some.page"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$crm_manager |
Assigned CRM manager |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify CRM: Manager
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$crm_manager", "value": "the best manager"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify CRM: Manager
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$crm_manager", "value": "the best manager"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$host_meeting_manager |
Manager hosting the meeting |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify CRM: Host meeting manager
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$host_meeting_manager", "value": "the best manager"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify CRM: Host meeting manager
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$host_meeting_manager", "value": "the best manager"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props
System key | Purpose |
---|---|
$crm_userlink |
User link in CRM system |
Authentification parameters.
id_as_string parameter.
Parameter | Type | Description |
---|---|---|
by_user_id |
Optional[boolean] | Should be true in case you're using User ID instead of Dashly ID. Default: false |
operations |
Array[Dict] | Array of atomic operations conducted on user's properties. Properties formats |
app |
Optional[ID] | ID of requesting application. Default: calculated based on access token. |
Identify CRM: User link
property for user with dashlyId=8173131
(our ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$crm_userlink", "value": "https://some.page"}]" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/8173131/props
Identify CRM: User link
property for user with UserId=user-7216
(your ID):
curl -X POST \
--data-urlencode "operations=[{"op": "update_or_create", "key": "$crm_userlink", "value": "https://some.page"}]" \
--data-urlencode "by_user_id=true" \
-H "Authorization: Token XXX" \
https://api.dashly.app/users/user-7216/props