Restore an opportunity

client.Opportunity.Restore(ctx, id, body) (*OpportunityRestoreResponse, error)

POST/v1/opportunities/{id}/restore

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

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

Required scope: opportunities:restore

Rate limit category: Write

ParametersExpand Collapse

id string

Unique identifier of the opportunity to restore.

body OpportunityRestoreParams

Body param.Field[OpportunityRestoreParamsBody]Optional

ReturnsExpand Collapse

type OpportunityRestoreResponse struct{…}

ID string

Unique identifier for the entity.

CreatedAt string

ISO 8601 timestamp of when the entity was created.

Fields map[string, OpportunityRestoreResponseField]

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

Value OpportunityRestoreResponseFieldValueUnion

The field value, or null if unset.

One of the following:

string

float64

bool

type OpportunityRestoreResponseFieldValueArray []string

type OpportunityRestoreResponseFieldValueAddress 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 OpportunityRestoreResponseFieldValueFullName 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 OpportunityRestoreResponseFieldValueTypeAddress OpportunityRestoreResponseFieldValueType = "ADDRESS"

const OpportunityRestoreResponseFieldValueTypeCheckbox OpportunityRestoreResponseFieldValueType = "CHECKBOX"

const OpportunityRestoreResponseFieldValueTypeCurrency OpportunityRestoreResponseFieldValueType = "CURRENCY"

const OpportunityRestoreResponseFieldValueTypeDatetime OpportunityRestoreResponseFieldValueType = "DATETIME"

const OpportunityRestoreResponseFieldValueTypeEmail OpportunityRestoreResponseFieldValueType = "EMAIL"

const OpportunityRestoreResponseFieldValueTypeFullName OpportunityRestoreResponseFieldValueType = "FULL_NAME"

const OpportunityRestoreResponseFieldValueTypeMarkdown OpportunityRestoreResponseFieldValueType = "MARKDOWN"

const OpportunityRestoreResponseFieldValueTypeMultiSelect OpportunityRestoreResponseFieldValueType = "MULTI_SELECT"

const OpportunityRestoreResponseFieldValueTypeNumber OpportunityRestoreResponseFieldValueType = "NUMBER"

const OpportunityRestoreResponseFieldValueTypeSingleSelect OpportunityRestoreResponseFieldValueType = "SINGLE_SELECT"

const OpportunityRestoreResponseFieldValueTypeSocialHandle OpportunityRestoreResponseFieldValueType = "SOCIAL_HANDLE"

const OpportunityRestoreResponseFieldValueTypeTelephone OpportunityRestoreResponseFieldValueType = "TELEPHONE"

const OpportunityRestoreResponseFieldValueTypeText OpportunityRestoreResponseFieldValueType = "TEXT"

const OpportunityRestoreResponseFieldValueTypeURL OpportunityRestoreResponseFieldValueType = "URL"

const OpportunityRestoreResponseFieldValueTypeHTML OpportunityRestoreResponseFieldValueType = "HTML"

HTTPLink string

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

Relationships map[string, OpportunityRestoreResponseRelationship]

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 OpportunityRestoreResponseRelationshipDirectionsOptional

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 OpportunityRestoreResponseRelationshipDirectionsAsDestination

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 OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasOne OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_ONE"

const OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinalityHasMany OpportunityRestoreResponseRelationshipDirectionsAsDestinationCardinality = "HAS_MANY"

Values []string

IDs of the related entities in this direction.

AsSource OpportunityRestoreResponseRelationshipDirectionsAsSource

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 OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinalityHasOne OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinality = "HAS_ONE"

const OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinalityHasMany OpportunityRestoreResponseRelationshipDirectionsAsSourceCardinality = "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 an opportunity

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"),
  )
  opportunityRestoreResponse, err := client.Opportunity.Restore(
    context.TODO(),
    "id",
    githubcomlightfldlightfieldgo.OpportunityRestoreParams{

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