Skip to content
Go to Micro

Delete a property definition

client.Prism.Properties.Delete(ctx, objectType, propertyID, params) error
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}

Removes the property definition and any of its options. Fails with 409 property_in_use if records still reference the property.

ParametersExpand Collapse
One of the following:
const PrismPropertyDeleteParamsObjectTypeComment PrismPropertyDeleteParamsObjectType = "comment"
const PrismPropertyDeleteParamsObjectTypeDeal PrismPropertyDeleteParamsObjectType = "deal"
const PrismPropertyDeleteParamsObjectTypeEngagement PrismPropertyDeleteParamsObjectType = "engagement"
const PrismPropertyDeleteParamsObjectTypeIdentity PrismPropertyDeleteParamsObjectType = "identity"
const PrismPropertyDeleteParamsObjectTypeAIChatThread PrismPropertyDeleteParamsObjectType = "ai_chat_thread"
const PrismPropertyDeleteParamsObjectTypeAIChatMessage PrismPropertyDeleteParamsObjectType = "ai_chat_message"
const PrismPropertyDeleteParamsObjectTypeAgentSite PrismPropertyDeleteParamsObjectType = "agent_site"
const PrismPropertyDeleteParamsObjectTypeDocument PrismPropertyDeleteParamsObjectType = "document"
const PrismPropertyDeleteParamsObjectTypeAction PrismPropertyDeleteParamsObjectType = "action"
const PrismPropertyDeleteParamsObjectTypeEvent PrismPropertyDeleteParamsObjectType = "event"
const PrismPropertyDeleteParamsObjectTypeOrganization PrismPropertyDeleteParamsObjectType = "organization"
const PrismPropertyDeleteParamsObjectTypeContact PrismPropertyDeleteParamsObjectType = "contact"
propertyID string
formatuuid
params PrismPropertyDeleteParams
TeamID param.Field[string]Optional

Path param

formatuuid

Query param: Storage type of this property definition.

const PrismPropertyDeleteParamsTypeNum PrismPropertyDeleteParamsType = "num"
const PrismPropertyDeleteParamsTypeStr PrismPropertyDeleteParamsType = "str"
const PrismPropertyDeleteParamsTypeBool PrismPropertyDeleteParamsType = "bool"
const PrismPropertyDeleteParamsTypeDate PrismPropertyDeleteParamsType = "date"
const PrismPropertyDeleteParamsTypeText PrismPropertyDeleteParamsType = "text"
const PrismPropertyDeleteParamsTypeByte PrismPropertyDeleteParamsType = "byte"
const PrismPropertyDeleteParamsTypeSelectStr PrismPropertyDeleteParamsType = "select_str"
const PrismPropertyDeleteParamsTypeMultiStr PrismPropertyDeleteParamsType = "multi_str"
const PrismPropertyDeleteParamsTypeMultiselectStr PrismPropertyDeleteParamsType = "multiselect_str"
const PrismPropertyDeleteParamsTypeJsonb PrismPropertyDeleteParamsType = "jsonb"
const PrismPropertyDeleteParamsTypeRefIdentity PrismPropertyDeleteParamsType = "ref_identity"
const PrismPropertyDeleteParamsTypeRefUser PrismPropertyDeleteParamsType = "ref_user"
const PrismPropertyDeleteParamsTypeRefOrganization PrismPropertyDeleteParamsType = "ref_organization"
const PrismPropertyDeleteParamsTypeRefContact PrismPropertyDeleteParamsType = "ref_contact"
const PrismPropertyDeleteParamsTypeRefThread PrismPropertyDeleteParamsType = "ref_thread"
const PrismPropertyDeleteParamsTypeRefMessage PrismPropertyDeleteParamsType = "ref_message"
const PrismPropertyDeleteParamsTypeRefEvent PrismPropertyDeleteParamsType = "ref_event"
const PrismPropertyDeleteParamsTypeRefAccount PrismPropertyDeleteParamsType = "ref_account"
const PrismPropertyDeleteParamsTypeRefAIChatThread PrismPropertyDeleteParamsType = "ref_ai_chat_thread"
const PrismPropertyDeleteParamsTypeRefAIChatMessage PrismPropertyDeleteParamsType = "ref_ai_chat_message"
const PrismPropertyDeleteParamsTypeMultirefAIChatMessage PrismPropertyDeleteParamsType = "multiref_ai_chat_message"
const PrismPropertyDeleteParamsTypeMultirefAgentSite PrismPropertyDeleteParamsType = "multiref_agent_site"
const PrismPropertyDeleteParamsTypeMultirefAction PrismPropertyDeleteParamsType = "multiref_action"
const PrismPropertyDeleteParamsTypeMultirefComment PrismPropertyDeleteParamsType = "multiref_comment"
const PrismPropertyDeleteParamsTypeMultirefContact PrismPropertyDeleteParamsType = "multiref_contact"
const PrismPropertyDeleteParamsTypeMultirefLabel PrismPropertyDeleteParamsType = "multiref_label"
const PrismPropertyDeleteParamsTypeMultirefThread PrismPropertyDeleteParamsType = "multiref_thread"
const PrismPropertyDeleteParamsTypeMultirefMessages PrismPropertyDeleteParamsType = "multiref_messages"
const PrismPropertyDeleteParamsTypeMultirefDocument PrismPropertyDeleteParamsType = "multiref_document"
const PrismPropertyDeleteParamsTypeMultirefIdentity PrismPropertyDeleteParamsType = "multiref_identity"
const PrismPropertyDeleteParamsTypeMultirefOrganization PrismPropertyDeleteParamsType = "multiref_organization"
const PrismPropertyDeleteParamsTypeMultirefEngagement PrismPropertyDeleteParamsType = "multiref_engagement"
const PrismPropertyDeleteParamsTypeMultirefAttendee PrismPropertyDeleteParamsType = "multiref_attendee"
const PrismPropertyDeleteParamsTypeMultirefMeetingEntry PrismPropertyDeleteParamsType = "multiref_meeting_entry"
const PrismPropertyDeleteParamsTypeMultirefReadReceipt PrismPropertyDeleteParamsType = "multiref_read_receipt"
const PrismPropertyDeleteParamsTypeMultirefAccount PrismPropertyDeleteParamsType = "multiref_account"
const PrismPropertyDeleteParamsTypeMultirefSource PrismPropertyDeleteParamsType = "multiref_source"
ListID param.Field[string]Optional

Query param

formatuuid

Delete a property definition

package main

import (
  "context"

  "github.com/micro-so/micro-sdk-go"
  "github.com/micro-so/micro-sdk-go/option"
)

func main() {
  client := micro.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithTeamID("My Team ID"),
  )
  err := client.Prism.Properties.Delete(
    context.TODO(),
    micro.PrismPropertyDeleteParamsObjectTypeComment,
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    micro.PrismPropertyDeleteParams{
      Type: micro.F(micro.PrismPropertyDeleteParamsTypeNum),
    },
  )
  if err != nil {
    panic(err.Error())
  }
}
Returns Examples