Skip to main content

Edit custom field

PUT https://www.digicert.com/services/v2/account/metadata/{{metadata_id}}

Use this endpoint to edit the specified metadata for a custom order field. Use the List custom fields endpoint for details about custom fields, including metadata IDs.

To change the value of a custom field for a specific order, use the Edit custom field value endpoint.

Example requests and responses

Example 1. cURL
curl -X PUT \
  'https://www.digicert.com/services/v2/account/metadata/{{metadata_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "label": "Additional Emails",
  "is_required": false,
  "is_active": true,
  "data_type": "email_address"
}'

Example 2. Python
import requests

url = "https://www.digicert.com/services/v2/account/metadata/{{metadata_id}}"

payload = "{\n  \"label\": \"Additional Emails\",\n  \"is_required\": false,\n  \"is_active\": true,\n  \"data_type\": \"email_address\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)

Example 3. Go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/account/metadata/{{metadata_id}}"

	payload := strings.NewReader("{\n  \"label\": \"Additional Emails\",\n  \"is_required\": false,\n  \"is_active\": true,\n  \"data_type\": \"email_address\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Example 4. NodeJS
var request = require("request");

var options = { method: 'PUT',
  url: 'https://www.digicert.com/services/v2/account/metadata/{{metadata_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { label: 'Additional Emails',
     is_required: false,
     is_active: true,
     data_type: 'email_address' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Request parameters

Name

Req/Opt

Type

Description

label

required

string

Name of the custom order field. When you use the CertCentral console to request a certificate, this name appears above the custom field on the certificateorder form.

is_required

optional

bool

Specify if this should be a required field.

Default: false

is_active

optional

bool

Specify if the field is active.

Default: true

data_type

optional

string

Input type for the custom order field. If omitted or left blank, an input type of anything is used. See .Glossary – Custom order field input types

show_in_receipt

optional

bool

If true, DigiCert displays the custom field on order receipts. Otherwise, false (default).

In this section: