{"id":3920,"date":"2023-09-21T14:33:28","date_gmt":"2023-09-21T13:33:28","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3920"},"modified":"2024-03-19T13:25:32","modified_gmt":"2024-03-19T12:25:32","slug":"changing-custom-properties-values","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/dynamic-content\/handling-custom-subscriber-properties\/changing-custom-properties-values\/","title":{"rendered":"Changing custom properties values"},"content":{"rendered":"\n

Dynamic Content can be used to automatically change custom subscriber values when the email is sent, using SetSubscriberProperty<\/code> method.<\/p>\n\n\n\n

Method signature:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
SetSubscriberProperty<\/span>(name<\/span>,<\/span> value)<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Method always returns empty string and can be put anywhere in the email. For example:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_number<\/span>'<\/span>,<\/span> <\/span>123<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
It is also possible to set subscriber properties conditionally, using standard logical syntax:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
<<\/span>if<\/span> <\/span>condition<\/span>=<\/span>'<\/span>HasSubscriberProperty(<\/span>'<\/span>is_client')'><\/span><\/span>\n    ${SetSubscriberProperty('is_client_and_got_email', true)}<\/span><\/span>\n<\/if><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
value<\/code> parameter will accept any object<\/code>, but it is important to set appropriate value, depending on custom property type. See examples below for different types of custom properties.<\/p>\n\n\n\n
Boolean properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_boolean<\/span>'<\/span>,<\/span> <\/span>true<\/span>)<\/span>}<\/span><\/span>\n$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_boolean<\/span>'<\/span>,<\/span> <\/span>false<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Text properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_text<\/span>'<\/span>,<\/span> <\/span>'<\/span>foobar<\/span>'<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Number properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_number<\/span>'<\/span>,<\/span> <\/span>123<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Money properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_money<\/span>'<\/span>,<\/span> <\/span>12.99<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
NOTE: Dot character (.) must be used as a decimal symbol.<\/p>\n\n\n\n
Date and DateTime properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_date<\/span>'<\/span>,<\/span> <\/span>'<\/span>2013-12-02<\/span>'<\/span>)<\/span>}<\/span><\/span>\n$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_datetime<\/span>'<\/span>,<\/span> <\/span>'<\/span>2013-12-02 10:15:00<\/span>'<\/span>)<\/span>}<\/span><\/span>\n$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_date<\/span>'<\/span>,<\/span> <\/span>new<\/span> <\/span>System<\/span>.<\/span>DateTime<\/span>(<\/span>2013<\/span>,<\/span> <\/span>12<\/span>,<\/span> <\/span>2<\/span>)<\/span>.<\/span>Date<\/span>)<\/span>}<\/span><\/span>\n$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_datetime<\/span>'<\/span>,<\/span> <\/span>new<\/span> <\/span>System<\/span>.<\/span>DateTime<\/span>(<\/span>2013<\/span>,<\/span> <\/span>12<\/span>,<\/span> <\/span>2<\/span>,<\/span> <\/span>10<\/span>,<\/span> <\/span>15<\/span>,<\/span> <\/span>0<\/span>))<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
NOTE: For convenience, it is possible to provide date\/datetime as a string, but it is required to use sortable (ISO) format: YYYY-MM-DD hh:mm:ss.<\/p>\n\n\n\n
All dates are treated as dates in business unit’s timezone.<\/p>\n\n\n\n
SingleSelect properties:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_singleselect<\/span>'<\/span>,<\/span> <\/span>'<\/span>value1<\/span>'<\/span>)<\/span>}<\/span><\/span>\n$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_singleselect<\/span>'<\/span>,<\/span> <\/span>'<\/span>value2<\/span>'<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
NOTE: Value set to custom single select property must be one of predefined values.<\/p>\n\n\n\n
Of course, it is possible to use expressions and other Dynamic Content methods as arguments, provided proper value type (e.g. using casting) is inserted:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
$<\/span>{<\/span>SetSubscriberProperty<\/span>(<\/span>'<\/span>some_number<\/span>'<\/span>,<\/span> (<\/span>int<\/span>)<\/span>GetSubscriberProperty<\/span>(<\/span>'<\/span>some_other_number<\/span>'<\/span>) <\/span>+<\/span> <\/span>123<\/span>)<\/span>}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
If for some reason, it is impossible to set subscriber property value (e.g. value is invalid or property name is unrecognized), the method will not do anything. Email will be sent as usual, without errors.<\/p>\n","protected":false},"author":6,"featured_media":0,"parent":3918,"menu_order":232,"template":"","format":"standard","emp-category":[],"class_list":["post-3920","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3920","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/6"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3920\/revisions"}],"predecessor-version":[{"id":8885,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3920\/revisions\/8885"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3918"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3920"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3920"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}