Restore a soft-deleted custom field

curl --request POST \
  --url https://api.arcuserp.com/v1/custom_fields/{id}/restore \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/custom_fields/{id}/restore', 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.arcuserp.com/v1/custom_fields/{id}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.arcuserp.com/v1/custom_fields/{id}/restore"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/custom_fields/{id}/restore")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "custom_field",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "account",
  "field_key": "tax_id_secondary",
  "label": "Secondary Tax ID",
  "field_type": "text",
  "required": false,
  "options": [
    "<string>"
  ],
  "default_value": "<string>",
  "help_text": "<string>",
  "display_order": 0,
  "is_active": true,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

POST

custom_fields

{id}

restore

Restore a soft-deleted custom field

curl --request POST \
  --url https://api.arcuserp.com/v1/custom_fields/{id}/restore \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.arcuserp.com/v1/custom_fields/{id}/restore', 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.arcuserp.com/v1/custom_fields/{id}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.arcuserp.com/v1/custom_fields/{id}/restore"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/custom_fields/{id}/restore")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "custom_field",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "account",
  "field_key": "tax_id_secondary",
  "label": "Secondary Tax ID",
  "field_type": "text",
  "required": false,
  "options": [
    "<string>"
  ],
  "default_value": "<string>",
  "help_text": "<string>",
  "display_order": 0,
  "is_active": true,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

Authorizations

Authorization

string

header

required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

string<uuid>

required

Response

Restored custom field

A user-defined custom field attached to a parent resource type (parent_type is one of: account, product, order, vendor_bill, etc.). Values are stored separately in entity_custom_field_values and read/ written via the /custom_fields/{parent_type}/{parent_id}/values and /custom_fields/{custom_field_id}/values/{parent_id} endpoints. Scope: custom_fields:read / custom_fields:write / custom_fields:delete.

string<uuid>

read-only

object

string

Example:

"custom_field"

entity_id

string<uuid>

read-only

parent_type

string

Parent resource type this field attaches to. 1..30 chars.

Example:

"account"

field_key

string

Stable machine identifier. 1..80 chars. Unique per (entity, parent_type).

Example:

"tax_id_secondary"

label

string

Human-readable label rendered in UI. 1..150 chars.

Example:

"Secondary Tax ID"

field_type

enum<string>

Storage type. Drives which value_* column is written in entity_custom_field_values.

Available options:

text,

number,

date,

datetime,

boolean,

json,

select,

multiselect

Example:

"text"

required

boolean

default:false

options

string[] | null

For select / multiselect field_type only.

default_value

string | null

help_text

string | null

display_order

integer

default:0

is_active

boolean

default:true

metadata

object

Free-form caller metadata. Default {}.

deleted_at

string<date-time> | null

read-only

Set by softDelete; cleared by restore.

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

Update a custom field definition List custom-field values for a parent record

Overview

All Endpoints

Restore a soft-deleted custom field

Authorizations

Path Parameters

Response