Restore a contact

client.Contact.Restore(ctx, id, body) (*ContactRestoreResponse, error)

POST/v1/contacts/{id}/restore

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

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

Required scope: contacts:restore

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the contact to restore.

body ContactRestoreParams

Body param.Field[ContactRestoreParamsBody]Optional

ReturnsExpand Collapse

type ContactRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, ContactRestoreResponseField]

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

Value ContactRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type ContactRestoreResponseFieldValueArray []string

type ContactRestoreResponseFieldValueAddress 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 ContactRestoreResponseFieldValueFullName 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 ContactRestoreResponseFieldValueTypeAddress ContactRestoreResponseFieldValueType = "ADDRESS"

const ContactRestoreResponseFieldValueTypeCheckbox ContactRestoreResponseFieldValueType = "CHECKBOX"

const ContactRestoreResponseFieldValueTypeCurrency ContactRestoreResponseFieldValueType = "CURRENCY"

const ContactRestoreResponseFieldValueTypeDatetime ContactRestoreResponseFieldValueType = "DATETIME"

const ContactRestoreResponseFieldValueTypeEmail ContactRestoreResponseFieldValueType = "EMAIL"

const ContactRestoreResponseFieldValueTypeFullName ContactRestoreResponseFieldValueType = "FULL_NAME"

const ContactRestoreResponseFieldValueTypeMarkdown ContactRestoreResponseFieldValueType = "MARKDOWN"

const ContactRestoreResponseFieldValueTypeMultiSelect ContactRestoreResponseFieldValueType = "MULTI_SELECT"

const ContactRestoreResponseFieldValueTypeNumber ContactRestoreResponseFieldValueType = "NUMBER"

const ContactRestoreResponseFieldValueTypeSingleSelect ContactRestoreResponseFieldValueType = "SINGLE_SELECT"

const ContactRestoreResponseFieldValueTypeSocialHandle ContactRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const ContactRestoreResponseFieldValueTypeTelephone ContactRestoreResponseFieldValueType = "TELEPHONE"

const ContactRestoreResponseFieldValueTypeText ContactRestoreResponseFieldValueType = "TEXT"

const ContactRestoreResponseFieldValueTypeURL ContactRestoreResponseFieldValueType = "URL"

const ContactRestoreResponseFieldValueTypeHTML ContactRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, ContactRestoreResponseRelationship]

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 ContactRestoreResponseRelationshipDirectionsOptional

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 ContactRestoreResponseRelationshipDirectionsAsDestination

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 ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const ContactRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource ContactRestoreResponseRelationshipDirectionsAsSource

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 ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const ContactRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany ContactRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 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"),
  )
  contactRestoreResponse, err := client.Contact.Restore(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.ContactRestoreParams{

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