Skip to content
Lightfield Lightfield
API Reference
Opportunity

Create an opportunity

$ lightfield opportunity create
POST/v1/opportunities

Creates a new opportunity record. The $name and $stage fields and the $account relationship are required.

After creation, Lightfield automatically generates an opportunity summary in the background. The $opportunityStatus field is read-only and cannot be set via the API. The $task and $note relationships are also read-only — manage them via the $opportunity relationship on the task, or the $account/$opportunity note relationships instead.

Supports idempotency via the Idempotency-Key header.

To avoid duplicates, we recommend a find-or-create pattern — use list filtering to check if a record exists before creating.

Required scope: opportunities:create

Rate limit category: Write

ParametersExpand Collapse
--fields: object { "$name", "$stage" }

Field values for the new opportunity. System fields use a $ prefix (e.g. $name, $stage); custom attributes use their bare slug. Required: $name (string) and $stage (option ID or label). Fields of type SINGLE_SELECT or MULTI_SELECT accept either an option ID or label from the field’s typeConfiguration.options — call the definitions endpoint to discover available fields and options. See Fields and relationships for value type details.

--relationships: object { "$account", "$champion", "$createdBy", 2 more }

Relationships to set on the new opportunity. System relationships use a $ prefix (e.g. $account, $owner); custom relationships use their bare slug. $account is required. Each value is a single entity ID or an array of IDs. Call the definitions endpoint to list available relationship keys.

ReturnsExpand Collapse
opportunity_create_response: object { id, createdAt, fields, 4 more }
id: string

Unique identifier for the entity.

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: map[object { value, valueType } ]

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

value: string or number or boolean or 3 more

The field value, or null if unset.

union_member_0: string
union_member_1: number
union_member_2: boolean
union_member_3: array of string
Address: object { city, country, latitude, 5 more }
city: optional string

City name.

country: optional string

2-letter ISO 3166-1 alpha-2 country code.

latitude: optional number

Latitude coordinate.

longitude: optional number

Longitude coordinate.

postalCode: optional string

Postal or ZIP code.

state: optional string

State or province.

street: optional string

Street address line 1.

street2: optional string

Street address line 2.

FullName: object { firstName, lastName }
firstName: optional string

The contact’s first name.

lastName: optional string

The contact’s last name.

valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more

The data type of the field.

"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
relationships: map[object { cardinality, objectType, values } ]

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: array of string

IDs of the related entities.

updatedAt: string

ISO 8601 timestamp of when the entity was last updated, or null.

externalId: optional string

External identifier for the entity, or null if unset.

Create an opportunity

lightfield opportunity create \
  --api-key 'My API Key' \
  --fields '{$name: $name, $stage: $stage}' \
  --relationships '{$account: string}'
{
  "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"
}