Delete a contact

client.Contact.Delete(ctx, id, body) (*ContactDeleteResponse, error)

DELETE/v1/contacts/{id}

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

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

Required scope: contacts:delete

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the contact to delete.

body ContactDeleteParams

Body param.Field[ContactDeleteParamsBody]Optional

ReturnsExpand Collapse

type ContactDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactDeleteResponseField]

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

Value ContactDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactDeleteResponseFieldValueArray []string

type ContactDeleteResponseFieldValueAddress 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 ContactDeleteResponseFieldValueFullName 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 ContactDeleteResponseFieldValueTypeAddress ContactDeleteResponseFieldValueType = "ADDRESS"

const ContactDeleteResponseFieldValueTypeCheckbox ContactDeleteResponseFieldValueType = "CHECKBOX"

const ContactDeleteResponseFieldValueTypeCurrency ContactDeleteResponseFieldValueType = "CURRENCY"

const ContactDeleteResponseFieldValueTypeDatetime ContactDeleteResponseFieldValueType = "DATETIME"

const ContactDeleteResponseFieldValueTypeEmail ContactDeleteResponseFieldValueType = "EMAIL"

const ContactDeleteResponseFieldValueTypeFullName ContactDeleteResponseFieldValueType = "FULL_NAME"

const ContactDeleteResponseFieldValueTypeMarkdown ContactDeleteResponseFieldValueType = "MARKDOWN"

const ContactDeleteResponseFieldValueTypeMultiSelect ContactDeleteResponseFieldValueType = "MULTI_SELECT"

const ContactDeleteResponseFieldValueTypeNumber ContactDeleteResponseFieldValueType = "NUMBER"

const ContactDeleteResponseFieldValueTypeSingleSelect ContactDeleteResponseFieldValueType = "SINGLE_SELECT"

const ContactDeleteResponseFieldValueTypeSocialHandle ContactDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const ContactDeleteResponseFieldValueTypeTelephone ContactDeleteResponseFieldValueType = "TELEPHONE"

const ContactDeleteResponseFieldValueTypeText ContactDeleteResponseFieldValueType = "TEXT"

const ContactDeleteResponseFieldValueTypeURL ContactDeleteResponseFieldValueType = "URL"

const ContactDeleteResponseFieldValueTypeHTML ContactDeleteResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ContactDeleteResponseRelationship]

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 a contact

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"),
  )
  contactDeleteResponse, err := client.Contact.Delete(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.ContactDeleteParams{

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