Restore a note

client.Note.Restore(ctx, id, body) (*NoteRestoreResponse, error)

POST/v1/notes/{id}/restore

Restores a trashed note, bringing it back to active. Find trashed notes via GET /v1/notes?status=trashed.

Calling restore on a note that is not trashed is a no-op and returns the existing record.

Required scope: notes:restore

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the note to restore.

body NoteRestoreParams

Body param.Field[NoteRestoreParamsBody]Optional

ReturnsExpand Collapse

type NoteRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, NoteRestoreResponseField]

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

Value NoteRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type NoteRestoreResponseFieldValueArray []string

type NoteRestoreResponseFieldValueAddress 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 NoteRestoreResponseFieldValueFullName 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 NoteRestoreResponseFieldValueTypeAddress NoteRestoreResponseFieldValueType = "ADDRESS"

const NoteRestoreResponseFieldValueTypeCheckbox NoteRestoreResponseFieldValueType = "CHECKBOX"

const NoteRestoreResponseFieldValueTypeCurrency NoteRestoreResponseFieldValueType = "CURRENCY"

const NoteRestoreResponseFieldValueTypeDatetime NoteRestoreResponseFieldValueType = "DATETIME"

const NoteRestoreResponseFieldValueTypeEmail NoteRestoreResponseFieldValueType = "EMAIL"

const NoteRestoreResponseFieldValueTypeFullName NoteRestoreResponseFieldValueType = "FULL_NAME"

const NoteRestoreResponseFieldValueTypeMarkdown NoteRestoreResponseFieldValueType = "MARKDOWN"

const NoteRestoreResponseFieldValueTypeMultiSelect NoteRestoreResponseFieldValueType = "MULTI_SELECT"

const NoteRestoreResponseFieldValueTypeNumber NoteRestoreResponseFieldValueType = "NUMBER"

const NoteRestoreResponseFieldValueTypeSingleSelect NoteRestoreResponseFieldValueType = "SINGLE_SELECT"

const NoteRestoreResponseFieldValueTypeSocialHandle NoteRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const NoteRestoreResponseFieldValueTypeTelephone NoteRestoreResponseFieldValueType = "TELEPHONE"

const NoteRestoreResponseFieldValueTypeText NoteRestoreResponseFieldValueType = "TEXT"

const NoteRestoreResponseFieldValueTypeURL NoteRestoreResponseFieldValueType = "URL"

const NoteRestoreResponseFieldValueTypeHTML NoteRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, NoteRestoreResponseRelationship]

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 NoteRestoreResponseRelationshipDirectionsOptional

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 NoteRestoreResponseRelationshipDirectionsAsDestination

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 NoteRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne NoteRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const NoteRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany NoteRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource NoteRestoreResponseRelationshipDirectionsAsSource

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 NoteRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne NoteRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const NoteRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany NoteRestoreResponseRelationshipDirectionsAsSourceCardinality = "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.

Restore 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"),
  )
  noteRestoreResponse, err := client.Note.Restore(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.NoteRestoreParams{

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