Wired Plus API Documentation

Raise a Technical Question with the Support Team

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

GET GetCustomField

Retrieves custom field by its ID.

Input and output parameters

The input and output parameters for this method are:

*denotes required field.

Input Parameter Name Type/Info
id* ID of the custom field.
Outputs:
  • id, of the custom field
  • record_name, record custom field is assign to, contact | product | cart | order
  • name, field name
  • description, details about the field
  • create_date, date record was created)
  • created_by, who created the record
  • update_date, date record was updated)
  • updated_by, who updated the record
  • dynamic_name, used to build up merge tags
  • type, data expected to be stored, 1=text, 2=number, 3=date
  • data_type_name, text representation of type
  • default_value, when null, this value will be used.
  • visibility, 0=private, 1=public
  • searchable, 0=no, 1=yes
  • required, will enforce this field is populated, 0=no, 1=yes
  • status, 0=disabled, 1=enabled

Examples

Curl

    
    
        
curl --request GET \
  --url https://api.wiredplus.com/v1/GetCustomField?id=1 \
    --header 'content-type: application/json;'

PHP

    
    

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.wiredplus.com/v1/GetCustomField?id=1",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "content-type: application/json;"
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

jQuery

    
    

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "https://api.wiredplus.com/v1/GetCustomField?id=1",
    "method": "GET",
    "headers": {},
    "processData": false,
    "contentType": false,
    "mimeType": "application/json"
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Result Format JSON

 

{
    "ID": "1",
    "record_name": "contact",
    "name": "Reg Plate",
    "description": "",
    "create_date": "2020-06-22 07:31:37",
    "created_by": "Jay",
    "update_date": "2020-06-23 13:49:06",
    "updated_by": "Jay",
    "dynamic_name": "REG_PLATE",
    "type": "1",
    "data_type_name": "text"
    "default_value": "n/a",
    "visibility": "1",
    "searchable": "0",
    "required": "0",
    "status": "1",
}