Skip to main content
POST
/
api
/
v1
/
tasks
Create a task
curl --request POST \
  --url https://shelfforce.ai/api/v1/tasks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "placeId": "<string>",
  "assignedTo": "<string>",
  "dueDate": "2023-12-25",
  "notes": "<string>",
  "inventoryItemIds": [
    "<string>"
  ],
  "standardIds": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": "<string>",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If a request with the same key was already processed within the last 24 hours, the cached response is returned with X-Idempotent-Replayed: true.

Example:

"idk_550e8400-e29b-41d4-a716-446655440000"

Body

application/json
​
title
string
required

Short descriptive title for the task.

Example:

"Check Coca-Cola facing at Walmart #4523"

​
placeId
string

Place ID to associate with this task.

Example:

"pl_abc123"

​
assignedTo
string

User ID to assign the task to.

Example:

"usr_qrs789"

​
dueDate
string<date>

Task due date in ISO 8601 date format.

Example:

"2026-03-15"

​
notes
string

Free-form notes or instructions.

Example:

"Verify the new promo display is set up correctly."

​
inventoryItemIds
string[]

Inventory item IDs to check during this task.

Example:
["inv_a1b2c3", "inv_d4e5f6"]
​
standardIds
string[]

Compliance standard IDs to evaluate.

Example:
["std_g7h8i9"]

Response

Task created.

​
data
object
required