PATCH /preferences/:recipient_id

URL: https://api.courier.com/preferences/:recipient_id

Method: PATCH

Path Parameters

recipient_idstringrequired

A unique identifier representing the recipient associated with the requested profile.

Body Parameters

patcharray

An array of patch operations. Learn more

+ Show Properties

Responses

status: 200 OK

statusstring

status: 400 Bad Request

messagestring

A message describing the error that occurred.

typestring

[invalid_request_error] The type of error that occurred.

Request Example

cURL

curl --request PATCH \
     --url https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6 \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
  "patch": [
    {
      "op": "replace",
      "path": "/email",
      "value": "test@example.com"
    }
  ]
}
'

Node.js

// Dependencies to install:
// $ npm install node-fetch --save

const fetch = require('node-fetch');

const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "patch": [
      {
        "op": "replace",
        "path": "/email",
        "value": "test@example.com"
      }
    ]
  })
};

fetch('https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"patch\":[{\"op\":\"replace\",\"path\":\"/email\",\"value\":\"test@example.com\"}]}"

response = http.request(request)
puts response.read_body

Python

# Dependencies to install:
# $ python -m pip install requests

import requests

url = "https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6"

payload = {
  "patch": [
    {
      "op": "replace",
      "path": "/email",
      "value": "test@example.com"
    }
  ]
}
headers = {
  "Accept": "application/json",
  "Content-Type": "application/json"
}

response = requests.request("PATCH", url, json=payload, headers=headers)

print(response.text)

Go

package main

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

func main() {

  url := "https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6"

  payload := strings.NewReader("{\"patch\":[{\"op\":\"replace\",\"path\":\"/email\",\"value\":\"test@example.com\"}]}")

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

  req.Header.Add("Accept", "application/json")
  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))

}

PHP

<?php
// Dependencies to install:
// $ composer require guzzlehttp/guzzle

require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6', [
  'body' => '{"patch":[{"op":"replace","path":"/email","value":"test@example.com"}]}',
  'headers' => [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

Responses Example

{
  "status": "SUCCESS"
}

{
  "message": "Error Message",
  "type": "invalid_request_error"
}