Delete a note

client.Note.Delete(ctx, id, body) (*NoteDeleteResponse, error)

DELETE/v1/notes/{id}

Moves a note to the trash. The note is soft-deleted and may be restored from the Lightfield UI.

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

Required scope: notes:delete

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the note to delete.

body NoteDeleteParams

Body param.Field[NoteDeleteParamsBody]Optional

ReturnsExpand Collapse

type NoteDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteDeleteResponseField]

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

Value NoteDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteDeleteResponseFieldValueArray []string

type NoteDeleteResponseFieldValueAddress 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 NoteDeleteResponseFieldValueFullName 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 NoteDeleteResponseFieldValueTypeAddress NoteDeleteResponseFieldValueType = "ADDRESS"

const NoteDeleteResponseFieldValueTypeCheckbox NoteDeleteResponseFieldValueType = "CHECKBOX"

const NoteDeleteResponseFieldValueTypeCurrency NoteDeleteResponseFieldValueType = "CURRENCY"

const NoteDeleteResponseFieldValueTypeDatetime NoteDeleteResponseFieldValueType = "DATETIME"

const NoteDeleteResponseFieldValueTypeEmail NoteDeleteResponseFieldValueType = "EMAIL"

const NoteDeleteResponseFieldValueTypeFullName NoteDeleteResponseFieldValueType = "FULL_NAME"

const NoteDeleteResponseFieldValueTypeMarkdown NoteDeleteResponseFieldValueType = "MARKDOWN"

const NoteDeleteResponseFieldValueTypeMultiSelect NoteDeleteResponseFieldValueType = "MULTI_SELECT"

const NoteDeleteResponseFieldValueTypeNumber NoteDeleteResponseFieldValueType = "NUMBER"

const NoteDeleteResponseFieldValueTypeSingleSelect NoteDeleteResponseFieldValueType = "SINGLE_SELECT"

const NoteDeleteResponseFieldValueTypeSocialHandle NoteDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const NoteDeleteResponseFieldValueTypeTelephone NoteDeleteResponseFieldValueType = "TELEPHONE"

const NoteDeleteResponseFieldValueTypeText NoteDeleteResponseFieldValueType = "TEXT"

const NoteDeleteResponseFieldValueTypeURL NoteDeleteResponseFieldValueType = "URL"

const NoteDeleteResponseFieldValueTypeHTML NoteDeleteResponseFieldValueType = "HTML"

HTTPLink string

URL to view the entity in the Lightfield web app, or null.

Relationships map[string, NoteDeleteResponseRelationship]

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 NoteDeleteResponseRelationshipDirectionsOptional

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 NoteDeleteResponseRelationshipDirectionsAsDestination

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 NoteDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const NoteDeleteResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteDeleteResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource NoteDeleteResponseRelationshipDirectionsAsSource

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 NoteDeleteResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteDeleteResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const NoteDeleteResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteDeleteResponseRelationshipDirectionsAsSourceCardinality = "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 a note

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"),
  )
  noteDeleteResponse, err := client.Note.Delete(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.NoteDeleteParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", noteDeleteResponse.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"
}