Restore a custom object record

client.Object.Restore(ctx, id, params) (*ObjectRestoreResponse, error)

POST/v1/objects/{entitySlug}/values/{id}/restore

Restores a trashed custom object record, bringing it back to active.

Calling restore on a record that is not trashed is a no-op and returns the existing record. A record of a different custom object type than entitySlug is reported as not found.

Required scope: custom_objects:restore

Rate limit category: Write

ParametersExpand Collapse

id string

The ID of the record to restore.

params ObjectRestoreParams

EntitySlug param.Field[string]

Path param: The slug of the custom object type.

Body param.Field[ObjectRestoreParamsBody]Optional

Body param

ReturnsExpand Collapse

type ObjectRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ObjectRestoreResponseField]

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

Value ObjectRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ObjectRestoreResponseFieldValueArray []string

type ObjectRestoreResponseFieldValueAddress 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 ObjectRestoreResponseFieldValueFullName 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 ObjectRestoreResponseFieldValueTypeAddress ObjectRestoreResponseFieldValueType = "ADDRESS"

const ObjectRestoreResponseFieldValueTypeCheckbox ObjectRestoreResponseFieldValueType = "CHECKBOX"

const ObjectRestoreResponseFieldValueTypeCurrency ObjectRestoreResponseFieldValueType = "CURRENCY"

const ObjectRestoreResponseFieldValueTypeDatetime ObjectRestoreResponseFieldValueType = "DATETIME"

const ObjectRestoreResponseFieldValueTypeEmail ObjectRestoreResponseFieldValueType = "EMAIL"

const ObjectRestoreResponseFieldValueTypeFullName ObjectRestoreResponseFieldValueType = "FULL_NAME"

const ObjectRestoreResponseFieldValueTypeMarkdown ObjectRestoreResponseFieldValueType = "MARKDOWN"

const ObjectRestoreResponseFieldValueTypeMultiSelect ObjectRestoreResponseFieldValueType = "MULTI_SELECT"

const ObjectRestoreResponseFieldValueTypeNumber ObjectRestoreResponseFieldValueType = "NUMBER"

const ObjectRestoreResponseFieldValueTypeSingleSelect ObjectRestoreResponseFieldValueType = "SINGLE_SELECT"

const ObjectRestoreResponseFieldValueTypeSocialHandle ObjectRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const ObjectRestoreResponseFieldValueTypeTelephone ObjectRestoreResponseFieldValueType = "TELEPHONE"

const ObjectRestoreResponseFieldValueTypeText ObjectRestoreResponseFieldValueType = "TEXT"

const ObjectRestoreResponseFieldValueTypeURL ObjectRestoreResponseFieldValueType = "URL"

const ObjectRestoreResponseFieldValueTypeHTML ObjectRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ObjectRestoreResponseRelationship]

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 ObjectRestoreResponseRelationshipDirectionsOptional

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 ObjectRestoreResponseRelationshipDirectionsAsDestination

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 ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany ObjectRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ObjectRestoreResponseRelationshipDirectionsAsSource

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 ObjectRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne ObjectRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ObjectRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany ObjectRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 custom object record

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"),
  )
  objectRestoreResponse, err := client.Object.Restore(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.ObjectRestoreParams{
      EntitySlug: "entitySlug",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", objectRestoreResponse.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"
}