Skip to content
Lightfield Lightfield
API Reference
Task

Create a task

task.create(TaskCreateParams**kwargs) -> TaskCreateResponse
POST/v1/tasks

Creates a new task record. The $title and $status fields and the $assignedTo relationship are required.

If $createdBy is omitted it defaults to the authenticated user. The $note relationship is read-only — manage notes via their own relationships.

Supports idempotency via the Idempotency-Key header.

Required scope: tasks:create

Rate limit category: Write

ParametersExpand Collapse
fields: Fields

Field values for the new task. Tasks only support the documented system fields, all prefixed with $ (e.g. $title, $status). Required: $title (string) and $status (one of TODO, IN_PROGRESS, COMPLETE, CANCELLED). Call the definitions endpoint to discover the available fields. See Fields and relationships for value type details.

status: str

Task status. One of: TODO, IN_PROGRESS, COMPLETE, CANCELLED.

title: str

Title of the task.

description: Optional[str]

Description of the task in markdown format.

due_at: Optional[str]

Due date as an ISO 8601 datetime string.

relationships: Union[Dict[str, Union[str, Sequence[str]]]]

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

One of the following:
Dict[str, Union[str, Sequence[str]]]
One of the following:
str
Sequence[str]
ReturnsExpand Collapse
class TaskCreateResponse: …
id: str

Unique identifier for the entity.

created_at: str

ISO 8601 timestamp of when the entity was created.

fields: Dict[str, Fields]

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

value: Optional[FieldsValue]

The field value, or null if unset.

One of the following:
str
float
bool
List[str]
class FieldsValueAddress: …
city: Optional[str]

City name.

country: Optional[str]

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

latitude: Optional[float]

Latitude coordinate.

longitude: Optional[float]

Longitude coordinate.

postal_code: Optional[str]

Postal or ZIP code.

state: Optional[str]

State or province.

street: Optional[str]

Street address line 1.

street2: Optional[str]

Street address line 2.

class FieldsValueFullName: …
first_name: Optional[str]

The contact’s first name.

last_name: Optional[str]

The contact’s last name.

value_type: Literal["ADDRESS", "CHECKBOX", "CURRENCY", 11 more]

The data type of the field.

One of the following:
"ADDRESS"
"CHECKBOX"
"CURRENCY"
"DATETIME"
"EMAIL"
"FULL_NAME"
"MARKDOWN"
"MULTI_SELECT"
"NUMBER"
"SINGLE_SELECT"
"SOCIAL_HANDLE"
"TELEPHONE"
"TEXT"
"URL"
relationships: Dict[str, Relationships]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

cardinality: str

Whether the relationship is has_one or has_many.

object_type: str

The type of the related object (e.g. account, contact).

values: List[str]

IDs of the related entities.

updated_at: Optional[str]

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

external_id: Optional[str]

External identifier for the entity, or null if unset.

Create a task

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
task_create_response = client.task.create(
    fields={
        "status": "$status",
        "title": "$title",
    },
    relationships={
        "foo": "string"
    },
)
print(task_create_response.id)
{
  "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"
}