Delete an account

client.Account.Delete(ctx, id, body) (*AccountDeleteResponse, error)

DELETE/v1/accounts/{id}

Moves an account to the trash. The account is soft-deleted and may be restored from the Lightfield UI. Associated contacts, tasks, and notes are not deleted; manage their lifecycle via their own endpoints.

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

Required scope: accounts:delete

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the account to delete.

body AccountDeleteParams

Body param.Field[AccountDeleteParamsBody]Optional

ReturnsExpand Collapse

type AccountDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, AccountDeleteResponseField]

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

Value AccountDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type AccountDeleteResponseFieldValueArray []string

type AccountDeleteResponseFieldValueAddress 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 AccountDeleteResponseFieldValueFullName 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 AccountDeleteResponseFieldValueTypeAddress AccountDeleteResponseFieldValueType = "ADDRESS"

const AccountDeleteResponseFieldValueTypeCheckbox AccountDeleteResponseFieldValueType = "CHECKBOX"

const AccountDeleteResponseFieldValueTypeCurrency AccountDeleteResponseFieldValueType = "CURRENCY"

const AccountDeleteResponseFieldValueTypeDatetime AccountDeleteResponseFieldValueType = "DATETIME"

const AccountDeleteResponseFieldValueTypeEmail AccountDeleteResponseFieldValueType = "EMAIL"

const AccountDeleteResponseFieldValueTypeFullName AccountDeleteResponseFieldValueType = "FULL_NAME"

const AccountDeleteResponseFieldValueTypeMarkdown AccountDeleteResponseFieldValueType = "MARKDOWN"

const AccountDeleteResponseFieldValueTypeMultiSelect AccountDeleteResponseFieldValueType = "MULTI_SELECT"

const AccountDeleteResponseFieldValueTypeNumber AccountDeleteResponseFieldValueType = "NUMBER"

const AccountDeleteResponseFieldValueTypeSingleSelect AccountDeleteResponseFieldValueType = "SINGLE_SELECT"

const AccountDeleteResponseFieldValueTypeSocialHandle AccountDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const AccountDeleteResponseFieldValueTypeTelephone AccountDeleteResponseFieldValueType = "TELEPHONE"

const AccountDeleteResponseFieldValueTypeText AccountDeleteResponseFieldValueType = "TEXT"

const AccountDeleteResponseFieldValueTypeURL AccountDeleteResponseFieldValueType = "URL"

const AccountDeleteResponseFieldValueTypeHTML AccountDeleteResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, AccountDeleteResponseRelationship]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

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.

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 account

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"),
  )
  accountDeleteResponse, err := client.Account.Delete(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.AccountDeleteParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", accountDeleteResponse.ID)
}

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "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"
      ]
    }
  },
  "updatedAt": "updatedAt",
  "externalId": "externalId"
}