API Reference

Update a Custom Field

Update Custom Field name and/or description.

Request

POST https://api.platform.ly

Method: update_custom_field

Request Body

{
  "api_key":"xxxxxxxxxxxxx",             //required
  "action": "update_custom_field",       //required
  "value": {
    "custom_field": 0,                   //required
    "name": "Custom Field Name",         //required *
    "desc": "Custom Field Description"   //required *
  }
}

curl --location --request POST 'https://api.platform.ly' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'api_key=xxxxxxxxxxxxx' \
--data-urlencode 'action=update_custom_field' \
--data-urlencode 'value={"custom_field": 0, "name": "Custom Field Name", "desc":"Custom Field Description"}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.platform.ly',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => 'api_key=xxxxxxxxxxxxx&action=update_custom_field&value=%7B%22custom_field%22%3A%200%2C%20%22name%22%3A%20%22Custom%20Field%20Name%22%2C%20%22desc%22%3A%22Custom%20Field%20Description%22%7D',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/x-www-form-urlencoded'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;


import requests

url = "https://api.platform.ly"

payload='api_key=xxxxxxxxxxxxx&action=update_custom_field&value=%7B%22custom_field%22%3A%200%2C%20%22name%22%3A%20%22Custom%20Field%20Name%22%2C%20%22desc%22%3A%22Custom%20Field%20Description%22%7D'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)


OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "api_key=xxxxxxxxxxxxx&action=update_custom_field&value={\"custom_field\": 0, \"name\": \"Custom Field Name\", \"desc\":\"Custom Field Description\"}");
Request request = new Request.Builder()
  .url("https://api.platform.ly")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();

Request Format

api_key required
Authentication API Key. Where can I find my API Key?

action required
update_custom_field

value required
JSON formatted string with additional request values

custom_field required
Your Custom Field ID. Where can I find my Segment ID?

name required *
Custom Field Name

desc required *
Custom Field Description.

* At least one of the following fields is required: name, description

Response

Returns a JSON success object if the request succeeded. Returns an error if the request parameters are invalid.

👍

200 OK

{
    "status": "success",
    "message": "The action has been processed"
}