Restore a soft-deleted contact

Clears deleted_at on a previously soft-deleted contact. Requires the contacts:write scope. 404 if the contact is not visible to the API key’s entity.

POST /contacts/{id}/restore

Restore a soft-deleted contact

cURL

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

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

fetch('https://api.arcuserp.com/v1/contacts/{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/contacts/{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/contacts/{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))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/contacts/{id}/restore")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/contacts/{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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "contact",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "first_name": "<string>",
  "last_name": "<string>",
  "full_name": "<string>",
  "email": "[e-mail]",
  "phone": "<string>",
  "mobile": "<string>",
  "title": "<string>",
  "role": "<string>",
  "is_primary": false,
  "notes": "<string>",
  "external_source": "<string>",
  "external_id": "<string>",
  "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

id · string<uuid> · required

Response

200

application/json

Restored contact

A polymorphic contact attached to a parent (account or vendor) via parent_type + parent_id. Only one contact per parent may be is_primary=true; setContactPrimary atomically demotes the previous primary. Soft-delete sets deleted_at; restore clears it. Scope: contacts:read / contacts:write / contacts:delete. Rule 23 SSOT: is_primary is flipped only by canonical setContactPrimary; full_name is derived from first_name + last_name on every write.

id · string<uuid> · read-only

object · string

Example:

"contact"

entity_id · string<uuid> · read-only

parent_type · enum<string>

Parent resource family.

Available options: account, vendor

parent_id · string<uuid>

first_name · string | null

1..100 chars.

last_name · string | null

1..100 chars.

full_name · string | null · read-only

Derived from first_name + last_name on write.

email · string<email> | null

phone · string | null

Free-format. 1..50 chars.

mobile · string | null

title · string | null

Job title at the parent organization.

role · string | null

Functional role at the parent (e.g. 'AP', 'Buyer', 'Shipping').

is_primary · boolean · default: false

notes · string | null

external_source · string | null

external_id · string | null

metadata · object

Free-form caller metadata. Default {}.

deleted_at · string<date-time> | null · read-only

created_at · string<date-time> · read-only

updated_at · string<date-time> · read-only