JSON API » bulk » bulk/destinations/get

Gets the fields of a bulk campaign destination.

Input parameters

Requires authentication and the user role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
campaignIntegerID of campaign containing destination.Yes
dnumberStringDestination to get.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The campaign or destination does not exist, or you do not have permission to view it.

Data returned

Fields of destination.

Example: With required parameters

http://enswitch.example.com/api/json/bulk/destinations/get/?auth_username=user;auth_password=password;campaign=123;dnumber=2125551234

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "dtype":"", "dnumber":"2125551234", ... } }

Change history

VersionChanges
3.13Function added.