retargeting.emails.get
Get email retargeting lists by list of IDs.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| array |
listIds ( |
|
|
int
|
|
|
(optional) Id of email retargeting list
|
|
) |
|
|
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
|
| array |
emails ( |
Array of email retargeting lists
|
| struct |
{ |
|
| int |
emailId |
Id of email retargeting list
|
| struct |
attributes { |
|
| string |
name |
Name of email retargeting list.
|
| string |
status |
Status:
-
active:
Active email retargeting list
-
paused:
Paused email retargeting list
|
| int |
retargetingId |
Retargeting code
|
| int |
membership |
Duration in days user will be in this
|
| int |
users |
Number of users in email list
|
| bool |
useHistoricData |
Include users by url requests requested
|
| bool |
takeAllUsers |
Include all url requests to email retargeting list.
|
| string |
description |
Description of email retargeting list
|
| datetime |
createDate |
Date of creating email retargeting list
|
| datetime |
suspendDate |
Date of closing email retargeting list
|
| datetime |
deleteDate |
Date of deleting email retargeting list
|
| bool |
deleted |
Whether list was deleted
|
|
} |
|
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
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:
retargeting_email_not_existretargeting_email_not_founduser_access_denied
