Update the technical contact

POST /api/ApiClient/updateTechnicalContact

Authentication

Send your private API key in the X-Api-Key header. Keep it on your server.

This request can change account configuration or stored data. Review the example values before running it.

Request example

Examples use illustrative values. Set FERRETLY_API_KEY in your server environment for JavaScript, Python, and C#. Replace sample IDs, URLs, and profile values before use.

curl --fail -sS -X POST "https://api.ferretly.com/api/ApiClient/updateTechnicalContact" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  --data-raw '"integrations@example.com"'

const response = await fetch("https://api.ferretly.com/api/ApiClient/updateTechnicalContact", {
  "method": "POST",
  "headers": {
    "X-Api-Key": process.env.FERRETLY_API_KEY,
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify("integrations@example.com")
});
if (!response.ok) throw new Error("HTTP " + response.status);
console.log(await response.json());

import os
import requests
import json

response = requests.request(
    "POST",
    "https://api.ferretly.com/api/ApiClient/updateTechnicalContact",
    headers={"X-Api-Key":os.environ["FERRETLY_API_KEY"],"Accept":"application/json","Content-Type":"application/json"},
    json=json.loads("\"integrations@example.com\""),
    timeout=30,
)
response.raise_for_status()
print(response.json())

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.ferretly.com/api/ApiClient/updateTechnicalContact");
request.Headers.Add("X-Api-Key", Environment.GetEnvironmentVariable("FERRETLY_API_KEY"));
request.Headers.Accept.ParseAdd("application/json");
request.Content = new StringContent("\"integrations@example.com\"", Encoding.UTF8, "application/json");
using var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request body

Use application/json for JSON examples. The published operation also advertises these content types.

application/json-patch+json: string
application/json: string
text/json: string
application/*+json: string

Responses

200

Success

text/plain: ApiClient
application/json: ApiClient
text/json: ApiClient

Response example

Illustrative, shortened HTTP 200 response. Optional fields can be absent or null.

{
  "subscriberId": "11111111-1111-4111-8111-111111111111",
  "organizationId": "22222222-2222-4222-8222-222222222222",
  "owner": "integrations@example.com",
  "statusUpdateCallbackUrl": "https://example.com/hooks/ferretly",
  "technicalContactEmail": "integrations@example.com",
  "allowPreferenceProfileUpdate": false
}

Response properties

Property	Type	Description
`subscriberId`	string (uuid)	The id of the Ferretly user associated with the API client key
`organizationId`	string (uuid)	The id of the Ferretly organization associated with the API client key
`owner`	string	Name of the API client key owner Nullable.
`permissions`	string	Comma-separated list of permissions associated with the API client Nullable.
`statusUpdateCallbackUrl`	string	Webhook URL Nullable.
`clientSpecificProperties`	string	A place to store additional, generic properties about the API Client Nullable.
`technicalContactEmail`	string	Email address of the technical contact for this API client organization. Nullable.
`allowPreferenceProfileUpdate`	boolean	Gets or sets a value indicating whether this API client is allowed to update preference profiles.