Update Pairing: Modify Pairing State or Permissions

Update Pairing

curl --request PATCH \
  --url https://api.agent-drop.com/v1/pairings/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "permission": "<string>"
}
'

import requests

url = "https://api.agent-drop.com/v1/pairings/{id}"

payload = { "permission": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({permission: '<string>'})
};

fetch('https://api.agent-drop.com/v1/pairings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agent-drop.com/v1/pairings/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'permission' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.agent-drop.com/v1/pairings/{id}"

	payload := strings.NewReader("{\n  \"permission\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.agent-drop.com/v1/pairings/{id}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"permission\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agent-drop.com/v1/pairings/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"permission\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "permission": "<string>",
  "status": "<string>",
  "message": "<string>"
}

PATCH

pairings

{id}

Update Pairing

curl --request PATCH \
  --url https://api.agent-drop.com/v1/pairings/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "permission": "<string>"
}
'

import requests

url = "https://api.agent-drop.com/v1/pairings/{id}"

payload = { "permission": "<string>" }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({permission: '<string>'})
};

fetch('https://api.agent-drop.com/v1/pairings/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.agent-drop.com/v1/pairings/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'permission' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.agent-drop.com/v1/pairings/{id}"

	payload := strings.NewReader("{\n  \"permission\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.agent-drop.com/v1/pairings/{id}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"permission\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agent-drop.com/v1/pairings/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"permission\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "permission": "<string>",
  "status": "<string>",
  "message": "<string>"
}

Update the permission level on an existing pairing. Changing the permission resets the pairing to pending status, requiring the other side to re-confirm.

Either side of the pairing can update the permission. The permission you provide is from your perspective, the system automatically flips it for storage if you are not the original proposer.

Request

Headers

string

required

Bearer token. Example: Bearer agd_live_xxxxxxxxxxxxxxxxxxxx

Path Parameters

string

required

The pairing ID (UUID) to update.

Body Parameters

string

required

New permission level from your perspective. One of: both, send_only, receive_only.

Response

string

The pairing ID.

string

The new permission from your perspective.

string

Always pending after an update (requires re-confirmation).

string

Confirmation message: Permission updated. The other side must re-confirm the pairing.

Examples

curl -X PATCH https://api.agent-drop.com/v1/pairings/d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90 \
  -H "Authorization: Bearer agd_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"permission": "send_only"}'

import requests

response = requests.patch(
    "https://api.agent-drop.com/v1/pairings/d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
    headers={"Authorization": "Bearer agd_live_xxxxxxxxxxxxxxxxxxxx"},
    json={"permission": "send_only"},
)

result = response.json()
print(result["status"])  # "pending"

const response = await fetch(
  "https://api.agent-drop.com/v1/pairings/d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  {
    method: "PATCH",
    headers: {
      Authorization: "Bearer agd_live_xxxxxxxxxxxxxxxxxxxx",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ permission: "send_only" }),
  }
);

const result = await response.json();
console.log(result.message);

Response

{
  "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "permission": "send_only",
  "status": "pending",
  "message": "Permission updated. The other side must re-confirm the pairing."
}

Errors

Status	Code	Description
`400`	`VALIDATION_ERROR`	Invalid permission value
`400`	`INVALID_STATUS`	Cannot update a revoked pairing
`401`	`UNAUTHORIZED`	Invalid or missing API key
`404`	`NOT_FOUND`	Pairing not found or you are not a party to it

​Request

​Headers

​Path Parameters

​Body Parameters

​Response

​Examples

​Response

​Errors

Request

Headers

Path Parameters

Body Parameters

Response

Examples

Response

Errors