JSON API » pagegroups » pagegroups/destinations/import

Imports page group destinations from a CSV file.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
csvStringThe contents of the CSV file.Yes
pagegroupIntegerID of page group to import into.Yes
deleteInteger1 to delete all destinations in page group first, 0 not to.No0

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
403Your rate plan does not allow this.
404The page group does not exist, or you do not have permission to view it.
500An internal error occurred. Check the key and message fields for more details.

Data returned

The number of destinations created.

Example: With required parameters (csv field omitted for brevity)

http://enswitch.example.com/api/json/pagegroups/destinations/import/?auth_username=user;auth_password=password;pagegroup=123;csv=...

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }

Change history

VersionChanges
3.13Function added.