Archive a contact field

DELETE

/v1/contact-fields/{id}

const url = 'https://api.threadkite.app/v1/contact-fields/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.threadkite.app/v1/contact-fields/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

It can no longer be set, and is hidden from lists; values already on contacts are kept. Bring it back with PATCH archived: false.

Authorizations

api_key
contacts:write

Parameters

Path Parameters

required

string format: uuid

Responses

200

application/json

object

required

Null for your industry pack’s fields, which every business like yours has

string format: uuid

nullable

key

required

The key values are stored under in a contact’s attributes; never changes

string

label

required

string

resource

required

contact (the default: values on contacts) or company (values on companies)

string

Allowed values: contact company

type

required

Values are text, numbers, dates (YYYY-MM-DD), true or false, or one of choices

string

Allowed values: text number date boolean choice

choices

required

The options of a choice field

Array<string>

origin

required

organisation (yours), pack (your industry pack) or integration

string

Allowed values: organisation pack integration

archived

required

Archived: values are kept but can no longer be set

boolean

readOnly

required

Pack fields cannot be changed or archived

boolean

createdAt

required

string format: date-time

nullable

Example

{
  "key": "finance_end_date",
  "label": "Finance end date",
  "resource": "contact",
  "type": "text",
  "origin": "organisation"
}

401

Missing or invalid API key

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

404

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}