Add note

2 minute read

POST https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note

Use this endpoint to add a note to an order.

Example requests and responses

curl -X POST \
  https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
	"text": "This is a note"
}'

import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

payload = "{\n\t\"text\": \"This is a note\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

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

print(response.text)

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note"

	payload := strings.NewReader("{\n\t\"text\": \"This is a note\"\n}")

	req, _ := http.NewRequest("POST", 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))

}

var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{order_id}}/note',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: { text: 'This is a note' },
  json: true };

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

  console.log(body);
});

201 Created

{
  "id": 2,
  "date_created": "2018-10-16T20:42:55+00:00",
  "text": "This is a note",
  "user": {
    "id": 15,
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@digicert.com"
  }
}

Request parameters

Name	Req/Opt	Type	Description
text	required	string	Note message to add to the order.

Response parameters

Name	Type	Description
id	int	Order ID.
date_created	string	Timestamp of when the note was created. Format: UTC timezone and ISO 8601 date
text	string	Message of the note.
user	object	Details about the user who added the note.
.. id	int	User ID.
.. first_name	string	First name of user.
.. last_name	string	Last name of user.
.. email	string	Email address of user.