Follow

Update Lists from Definition

**Coming end of January 2018**

 

The Update Lists from List Definition command allows you to sync any changes made to the List Definition to one or more Lists which were created from the definition.   The command requires the following arguments: Command, Realm, Password, List Definition ID, and one or more List IDs.

api_web?r=myrealm&p=mypass&c=updatelistsfromdefinition&list_definition_id=42&update_list_ids=48,52,73

The command is ‘updatelistsfromdefinition’, the realm is ‘myrealm’ and the password is ‘mypass’ and changes from definition with id 42 is applied to the lists 48,52, and 73.

Example

Using all commands and arguments by ID (please note the command is wrapped for display purposes only):

api_web?r=myrealm&p=mypass&c=updatelistsfromdefinition&list_definition_id=10&update_list_ids=11,12,13

Successful results return:

SUCCESS: Lists updated: 11,12,13

 

Results

The Update Lists from List Definition command outputs either a SUCCESS or FAILURE message. 

Success

The command success message returns the SUCCESS message followed by a comma separated list of the List IDs for the updated lists.  The result format is 

SUCCESS: Lists updated: [list_id1,list_id2...list_idn] 

Failure

The command will fail for several reasons, such as if the List Definition does not exist, or if the List ID is for a list not created from the definition.  The result format is:

FAILURE: [Reason]  

Arguments

The Update Lists from List Definition command supports the following arguments:

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=updatelistsfromdefinition

c=updatelistsfromdefinition

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

List Definition Identification  Yest

ID of the list definition from which to sync properties.  

list_definition_id=[list_definition_id]

List Identification

Yes

Comma separated list of IDs for the lists properties to update.

update_list_ids=[list_id1,list_id2,...list_idn]

*Feature released in v13.0.0.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk