BatchContactParameters

Parameters for batch operations performed on contacts

Fields

FieldDescription
name
string

Selection name, used for operation sendselection

Example value:"Christmas Mailing"
fields
ContactBatchUpdate 
(required)

[DEPRECATED] Use updatefields instead

Example value:{ "languagecode": "en" }
ids
int[]

Relation type IDs, used for operations addrelationtypes and removerelationtypes

Example value:[ 21, 49 ]
primary
int

Primary contact to merge into

Example value:1242443
updatefields

Set of fields to update, used for operation update. Custom fields are also supported.

Example value:[ { "key": "languagecode", "value": "en" } ]

Example

 1{
 2    "name": "Christmas Mailing",
 3    "fields": {
 4        "languagecode": "en"
 5    },
 6    "ids": [ 21, 49 ],
 7    "primary": 1242443,
 8    "updatefields": [
 9        {
10            "key": "languagecode",
11            "value": "en"
12        }
13    ]
14}