Patch Card Field - AnyCRM API

Patch Card Field

curl --request PATCH \
  --url https://api.example.com/cards/{card_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "value": "<string>",
  "icon": "<string>",
  "position": 123
}
'

import requests

url = "https://api.example.com/cards/{card_id}/fields/{field_id}"

payload = {
    "label": "<string>",
    "value": "<string>",
    "icon": "<string>",
    "position": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', value: '<string>', icon: '<string>', position: 123})
};

fetch('https://api.example.com/cards/{card_id}/fields/{field_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.example.com/cards/{card_id}/fields/{field_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([
    'label' => '<string>',
    'value' => '<string>',
    'icon' => '<string>',
    'position' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.example.com/cards/{card_id}/fields/{field_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/cards/{card_id}/fields/{field_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/cards/{card_id}/fields/{field_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}"

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

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

/

cards

/

{card_id}

/

fields

/

{field_id}

Patch Card Field

curl --request PATCH \
  --url https://api.example.com/cards/{card_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "value": "<string>",
  "icon": "<string>",
  "position": 123
}
'

import requests

url = "https://api.example.com/cards/{card_id}/fields/{field_id}"

payload = {
    "label": "<string>",
    "value": "<string>",
    "icon": "<string>",
    "position": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({label: '<string>', value: '<string>', icon: '<string>', position: 123})
};

fetch('https://api.example.com/cards/{card_id}/fields/{field_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.example.com/cards/{card_id}/fields/{field_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([
    'label' => '<string>',
    'value' => '<string>',
    'icon' => '<string>',
    'position' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.example.com/cards/{card_id}/fields/{field_id}"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/cards/{card_id}/fields/{field_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/cards/{card_id}/fields/{field_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"value\": \"<string>\",\n  \"icon\": \"<string>\",\n  \"position\": 123\n}"

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

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

card_id

string

required

field_id

string

required

Body

application/json

field_type

enum<string> | null

Available options:

phone,

email,

url,

address,

social,

custom,

social_x,

social_linkedin,

social_instagram,

social_threads,

social_facebook,

social_youtube,

social_tiktok,

social_twitch,

social_snapchat,

social_yelp,

social_reddit,

social_bluesky,

messaging_whatsapp,

messaging_signal,

messaging_telegram,

messaging_discord,

messaging_skype,

messaging_imessage,

business_github,

business_calendly,

business_company_url,

payment_paypal,

payment_venmo,

payment_cashapp

label

string | null

value

string | null

icon

string | null

position

integer | null

visibility

enum<string> | null

Available options:

public,

on_share_back

Response

Successful Response

The response is of type Response Patch Card Field Route Cards Card Id Fields Field Id Patch · object.