Delete a task

client.Task.Delete(ctx, id, body) (*TaskDeleteResponse, error)

DELETE/v1/tasks/{id}

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

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

Required scope: tasks:delete

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the task to delete.

body TaskDeleteParams

Body param.Field[TaskDeleteParamsBody]Optional

ReturnsExpand Collapse

type TaskDeleteResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, TaskDeleteResponseField]

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

Value TaskDeleteResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type TaskDeleteResponseFieldValueArray []string

type TaskDeleteResponseFieldValueAddress 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 TaskDeleteResponseFieldValueFullName 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 TaskDeleteResponseFieldValueTypeAddress TaskDeleteResponseFieldValueType = "ADDRESS"

const TaskDeleteResponseFieldValueTypeCheckbox TaskDeleteResponseFieldValueType = "CHECKBOX"

const TaskDeleteResponseFieldValueTypeCurrency TaskDeleteResponseFieldValueType = "CURRENCY"

const TaskDeleteResponseFieldValueTypeDatetime TaskDeleteResponseFieldValueType = "DATETIME"

const TaskDeleteResponseFieldValueTypeEmail TaskDeleteResponseFieldValueType = "EMAIL"

const TaskDeleteResponseFieldValueTypeFullName TaskDeleteResponseFieldValueType = "FULL_NAME"

const TaskDeleteResponseFieldValueTypeMarkdown TaskDeleteResponseFieldValueType = "MARKDOWN"

const TaskDeleteResponseFieldValueTypeMultiSelect TaskDeleteResponseFieldValueType = "MULTI_SELECT"

const TaskDeleteResponseFieldValueTypeNumber TaskDeleteResponseFieldValueType = "NUMBER"

const TaskDeleteResponseFieldValueTypeSingleSelect TaskDeleteResponseFieldValueType = "SINGLE_SELECT"

const TaskDeleteResponseFieldValueTypeSocialHandle TaskDeleteResponseFieldValueType = "SOCIAL_HANDLE"

const TaskDeleteResponseFieldValueTypeTelephone TaskDeleteResponseFieldValueType = "TELEPHONE"

const TaskDeleteResponseFieldValueTypeText TaskDeleteResponseFieldValueType = "TEXT"

const TaskDeleteResponseFieldValueTypeURL TaskDeleteResponseFieldValueType = "URL"

const TaskDeleteResponseFieldValueTypeHTML TaskDeleteResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, TaskDeleteResponseRelationship]

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 task

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"),
  )
  taskDeleteResponse, err := client.Task.Delete(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.TaskDeleteParams{

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