Follow

Delete Custom Field

The Delete Custom Field command allows you to delete a custom subscriber data field that may no longer be of use.

Arguments

The Delete Custom Field command requires the following arguments: Command, Realm, Password, and Field Name.

api_web?r=myrealm&p=mypass&c=customfielddelete&fieldname=age

The command is ‘customfielddelete', the realm is ‘myrealm’ and the password is ‘mypass’.  The custom field will named ‘age’ will be deleted.  Any data associated with subscribers will remain in the system, but will no longer be accessible.

The Delete Custom Field command supports the following arguments:

 

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=[customfielddelete]

c=[customfielddelete]

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]

Field Name

Yes

Name of the custom field to delete.

fieldname=[custom_field_name]

 

Example

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

api_web?r=myrealm&p=mypass&c=customfielddelete&fieldname=gender

Successful results return:

SUCCESS: Deleted custom field 'gender'

Results

The Delete Custom Field command outputs either a SUCCESS or FAILURE message. 

SUCCESS

The Delete Custom Field command success message returns the SUCCESS message and includes the name of the deleted Custom Field.  The result format is:

SUCCESS: Deleted custom field '[fieldname]'

FAILURE

A Delete Custom Field command will fail if a custom field does not exist or invalid data is defined.  The result format is:

FAILURE: [Reason]  

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

Comments

Powered by Zendesk