Skip to content

Delete an opportunity

client.Opportunity.Delete(ctx, id, body) (*OpportunityDeleteResponse, error)
DELETE/v1/opportunities/{id}

Moves an opportunity to the trash. The opportunity is soft-deleted and may be restored from the Lightfield UI. Associated tasks, notes, and meetings are not deleted.

Calling delete on an already-trashed opportunity is a no-op and returns the existing record.

Required scope: opportunities:delete

Rate limit category: Write

ParametersExpand Collapse
id string

Unique identifier of the opportunity to delete.

body OpportunityDeleteParams
Body param.Field[OpportunityDeleteParamsBody]Optional
ReturnsExpand Collapse
type OpportunityDeleteResponse struct{…}
ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityDeleteResponseField]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

Value OpportunityDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:
string
float64
bool
type OpportunityDeleteResponseFieldValueArray []string
type OpportunityDeleteResponseFieldValueAddress struct{…}
City stringOptional

City name.

Country stringOptional

2-letter ISO 3166-1 alpha-2 country code.

Latitude float64Optional

Latitude coordinate.

Longitude float64Optional

Longitude coordinate.

PostalCode stringOptional

Postal or ZIP code.

State stringOptional

State or province.

Street stringOptional

Street address line 1.

Street2 stringOptional

Street address line 2.

type OpportunityDeleteResponseFieldValueFullName struct{…}
FirstName stringOptional

The contact’s first name.

LastName stringOptional

The contact’s last name.

ValueType string

The data type of the field.

One of the following:
const OpportunityDeleteResponseFieldValueTypeAddress OpportunityDeleteResponseFieldValueType = "ADDRESS"
const OpportunityDeleteResponseFieldValueTypeCheckbox OpportunityDeleteResponseFieldValueType = "CHECKBOX"
const OpportunityDeleteResponseFieldValueTypeCurrency OpportunityDeleteResponseFieldValueType = "CURRENCY"
const OpportunityDeleteResponseFieldValueTypeDate OpportunityDeleteResponseFieldValueType = "DATE"
const OpportunityDeleteResponseFieldValueTypeDatetime OpportunityDeleteResponseFieldValueType = "DATETIME"
const OpportunityDeleteResponseFieldValueTypeEmail OpportunityDeleteResponseFieldValueType = "EMAIL"
const OpportunityDeleteResponseFieldValueTypeFullName OpportunityDeleteResponseFieldValueType = "FULL_NAME"
const OpportunityDeleteResponseFieldValueTypeMarkdown OpportunityDeleteResponseFieldValueType = "MARKDOWN"
const OpportunityDeleteResponseFieldValueTypeMultiSelect OpportunityDeleteResponseFieldValueType = "MULTI_SELECT"
const OpportunityDeleteResponseFieldValueTypeNumber OpportunityDeleteResponseFieldValueType = "NUMBER"
const OpportunityDeleteResponseFieldValueTypeSingleSelect OpportunityDeleteResponseFieldValueType = "SINGLE_SELECT"
const OpportunityDeleteResponseFieldValueTypeSocialHandle OpportunityDeleteResponseFieldValueType = "SOCIAL_HANDLE"
const OpportunityDeleteResponseFieldValueTypeTelephone OpportunityDeleteResponseFieldValueType = "TELEPHONE"
const OpportunityDeleteResponseFieldValueTypeText OpportunityDeleteResponseFieldValueType = "TEXT"
const OpportunityDeleteResponseFieldValueTypeURL OpportunityDeleteResponseFieldValueType = "URL"
const OpportunityDeleteResponseFieldValueTypeHTML OpportunityDeleteResponseFieldValueType = "HTML"
Relationships map[string, OpportunityDeleteResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact). A self-referential relationship keeps its merged values and includes optional directional values. List filters select the current record’s role with :asSource or :asDestination, for example ?parent:asSource[contains]=account_id.

Cardinality string

Whether the relationship is has_one or has_many.

ObjectType string

The type of the related object (e.g. account, contact).

Values []string

IDs of the related entities.

Directions OpportunityDeleteResponseRelationshipDirectionsOptional

Directional values for a self-referential relationship. List filters use the relationship key with :asSource or :asDestination; writes continue to use the bare key.

AsDestination OpportunityDeleteResponseRelationshipDirectionsAsDestination

The current record is the destination (incoming) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"
const OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

AsSource OpportunityDeleteResponseRelationshipDirectionsAsSource

The current record is the source (outgoing) endpoint.

Cardinality string

Whether this endpoint direction is HAS_ONE or HAS_MANY.

One of the following:
const OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"
const OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_MANY"
Values []string

IDs of the related entities in this direction.

UpdatedAt string

ISO 8601 timestamp of when the entity was last updated, or null.

ExternalID stringOptional

External identifier for the entity, or null if unset.

Delete an opportunity

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  opportunityDeleteResponse, err := client.Opportunity.Delete(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.OpportunityDeleteParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", opportunityDeleteResponse.ID)
}
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}
Returns Examples
{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ],
      "directions": {
        "asDestination": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        },
        "asSource": {
          "cardinality": "HAS_ONE",
          "values": [
            "string"
          ]
        }
      }
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}