retargeting.lists.update
Update retargeting lists with new attributes and groups of conditions
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
lists ( |
Array of retargeting lists
|
| struct |
{ |
|
| int |
listId |
Retargeting list ID
|
| struct |
attributes { |
(optional)
|
| string |
name |
(optional) Name of retargeting list
|
| int |
membership |
(optional) Duration in days user will be in this
|
| bool |
useHistoricData |
(optional) Include users by url requests requested
|
| string |
description |
(optional) Description of Retargeting list.
|
| string |
status |
(optional) Status of retargeting list:
-
active:
active list
-
suspend:
suspended list
|
|
} |
|
|
| array |
conditionGroups ( |
(optional) Groups of conditions
|
| struct |
{ |
|
| int |
conditionGroupId |
(optional) Id of group of conditions
|
| bool |
delete |
(optional) If true, this group will be deleted
|
| array |
conditions ( |
(optional) List of Conditions (in that group)
|
| struct |
{ |
|
| int |
conditionId |
(optional) Id of condition
|
| bool |
delete |
(optional) If true, this condition will be deleted
|
| string |
type |
(optional) Type of condition:
-
contains:
contains
-
not_contains:
not contains
-
equals:
equals
-
not_equals:
not equals
-
starts:
starts
-
not_starts:
not starts
-
ends:
ends
-
not_ends:
not ends
|
| string |
value |
(optional) Value of condition (ex. part of url)
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see below)
|
| string |
statusMessage |
Status code description
|
| struct |
diagnostics { |
(optional) Additional information about processed request (see below)
|
} |
|
|
| string |
session |
(optional) Refreshed session
|
| int |
count |
Number of updated lists
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
attribute_conditions_must_be_present_for_create_condition_groupattribute_id_must_be_present_for_delete_conditionattribute_id_must_be_present_for_delete_condition_groupattribute_id_must_be_present_for_update_conditionattribute_type_must_be_present_for_create_conditionattribute_value_must_be_present_for_create_conditionretargeting_list_condition_emptyretargeting_list_condition_group_not_foundretargeting_list_condition_not_foundretargeting_list_membership_out_of_rangeretargeting_list_name_emptyretargeting_list_name_uniqueretargeting_list_not_existretargeting_list_not_founduser_access_denied
