Appearance

Delete Fields ​

Endpoint ​

http
DELETE /unified/crm/fields/{id}
Integrations supported
  • Capsule
  • Close
  • Pipedrive

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
entity
string

The entity to get the fields for

All possible enum values:
  • account
  • contact
  • lead
  • opportunity
Enum support by integration
  • Close
    • contact
    • account
    • opportunity
  • Pipedrive
    • contact
    • account
    • opportunity
    • lead
  • Capsule
    • contact
    • account
    • opportunity
Required in
  • Capsule
  • Close
  • Pipedrive

Response Body ​

id
string

The field's unique identifier

Supported in
  • Capsule
name
string

The field's name. This is the name of the property in the entity.

label
string

The field's label

description
string

The field's description

type
string

The field's type

All possible enum values:
  • string
  • text
  • rich_text
  • number
  • boolean
  • date
  • datetime
  • time
  • enum
  • array
  • file
  • address
is_hidden
boolean

Whether the field is hidden

is_unique
boolean

Whether the field is unique

is_required
boolean

Whether the field is required

is_editable
boolean

Whether the field is editable

options
object[]

The field's options

label
string

The option's label

value
string

The option's value

description
string

The option's description

is_hidden
boolean

Whether the option is hidden

is_user_defined
boolean

Whether the field is user defined

entity_type
string

The entity type the field belongs to

All possible enum values:
  • contact
  • account
  • opportunity
field_groups
object[]
id
string

The field group's unique identifier

name
string

The field group's name

created_at
string · date-time

The date and time of the field's creation

updated_at
string · date-time

The date and time of the field's last update

urls
object[]

The field's urls

url
string

The field's URL

type
string

The field's URL type

remote_data
object

Raw data returned from the remote API call.