Boxes

Creates a box in the specified pipeline

post/v2/pipelines/{pipelineKey}/boxes

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/pipelines/{pipelineKey}/boxes
  • Auth
    HTTP bearer

Path parameters

pipelineKeystring required

Query parameters

overrideValidatorboolean

Override blocking box validation rules when the current user has permission.

Request body

notesstring nullable

Box notes. An empty string clears the notes.

stageKeystring nullable

Stage key in the pipeline. Omit to keep the current or default stage.

fieldsobject nullable

Custom field values keyed by field key. Null entries leave fields unchanged.

linkedBoxKeysstring[] nullable

Linked boxes. An empty list removes all links.

followerKeysstring[] nullable

Users following the box. An empty list removes all followers.

namestring required

Name of the new box. Must not be empty.

Response

OK

lastSavedTimestampinteger nullable

Time this box was last persisted, in epoch milliseconds.

pipelineKeystring nullable

Key of the pipeline containing this box.

creatorKeystring nullable

Creator key for this box.

creationTimestampinteger nullable

Creation timestamp for this box, in epoch milliseconds.

lastUpdatedTimestampinteger nullable

Last updated timestamp for this box, in epoch milliseconds.

lastEmailUpdatedTimestampinteger nullable

Last email updated timestamp for this box, in epoch milliseconds.

lastStageChangeTimestampinteger nullable

Last stage change timestamp for this box, in epoch milliseconds.

lastCommentTimestampinteger nullable

Last comment timestamp for this box, in epoch milliseconds.

lastEmailFromstring nullable

Last email from for this box.

firstEmailFromstring nullable

First email from for this box.

totalNumberOfEmailsinteger

Total number of emails for this box.

totalNumberOfSentEmailsinteger

Total number of sent emails for this box.

totalNumberOfLastSentEmailViewsinteger

Total number of last sent email views for this box.

totalNumberOfLastSentEmailLinksClicksinteger

Total number of last sent email links clicks for this box.

totalNumberOfSentEmailsViewsinteger

Total number of sent emails views for this box.

totalNumberOfReceivedEmailsinteger

Total number of received emails for this box.

firstEmailTimestampinteger nullable

First email timestamp for this box, in epoch milliseconds.

firstEmailSentTimestampinteger nullable

First email sent timestamp for this box, in epoch milliseconds.

firstEmailReceivedTimestampinteger nullable

First email received timestamp for this box, in epoch milliseconds.

lastEmailSentTimestampinteger nullable

Last email sent timestamp for this box, in epoch milliseconds.

lastEmailReceivedTimestampinteger nullable

Last email received timestamp for this box, in epoch milliseconds.

namestring nullable

Display name of the box.

notesstring nullable

Free-form notes saved on the box.

summarySnippetstring nullable

Generated summary snippet for the box.

stageKeystring nullable

Key of the box stage within its pipeline.

followerKeysstring[] nullable

Follower keys for this box.

linkedBoxKeysstring[] nullable

Linked box keys for this box.

emailAddressesAutoExtractedstring[] nullable

Email addresses extracted from the box emails.

emailAddressesBlackliststring[] nullable

Email addresses excluded from the composed box email list.

emailAddressesstring[] required

Extracted email addresses after excluding the blacklist.

taskCompleteCountinteger

Task complete count for this box.

taskIncompleteCountinteger

Task incomplete count for this box.

taskOverdueCountinteger

Task overdue count for this box.

taskAssigneeKeySetstring[] nullable

Task assignee key set for this box.

soonestTaskDueDateinteger nullable

Soonest task due date for this box, in epoch milliseconds.

earliestOverdueTaskDueDateinteger nullable

Earliest overdue task due date for this box, in epoch milliseconds.

overdueTaskAssigneeKeySetstring[] nullable

Overdue task assignee key set for this box.

incompleteTaskAssigneeKeySetstring[] nullable

Incomplete task assignee key set for this box.

taskPercentageCompletenumber double

Fraction of box tasks that are complete; zero when there are no tasks.

taskTotalinteger

Task total for this box.

creationSourceType'HUMAN' | 'SYSTEM_ONBOARDING' | 'AI_PIPELINE_CREATOR' nullable

Creation source type for this box.

callLogCountinteger

Call log count for this box.

meetingNotesCountinteger

Meeting notes count for this box.

mostRecentCallLogTimestampinteger nullable

Most recent call log timestamp for this box, in epoch milliseconds.

mostRecentMeetingNotesTimestampinteger nullable

Most recent meeting notes timestamp for this box, in epoch milliseconds.

eventCountinteger

Number of meetings and synced calendar events for this box, excluding no-shows.

firstEventTimestampinteger nullable

Earliest past meeting or calendar event for this box, in epoch milliseconds.

lastEventTimestampinteger nullable

Most recent past meeting or calendar event for this box, in epoch milliseconds.

nextEventTimestampinteger nullable

Next upcoming meeting or calendar event for this box, in epoch milliseconds.

mostRecentLastSentEmailViewsTimestampinteger nullable

Most recent last sent email views timestamp for this box, in epoch milliseconds.

mostRecentLastSentEmailLinkClickedTimestampinteger nullable

Most recent last sent email link clicked timestamp for this box, in epoch milliseconds.

mostRecentSentEmailsViewsTimestampinteger nullable

Most recent sent emails views timestamp for this box, in epoch milliseconds.

firstCallLogTimestampinteger nullable

First call log timestamp for this box, in epoch milliseconds.

firstMeetingNotesTimestampinteger nullable

First meeting notes timestamp for this box, in epoch milliseconds.

totalCallLogDurationinteger

Total call log duration for this box.

totalMeetingNotesDurationinteger

Total meeting notes duration for this box.

lastTouchpointTimestampinteger nullable

Last touchpoint timestamp for this box, in epoch milliseconds.

lastTouchpointType'EMAIL' | 'CALL' | 'MEETING' nullable

Last touchpoint type for this box.

followerCountinteger

Follower count for this box.

commentCountinteger

Comment count for this box.

gmailThreadCountinteger

Gmail thread count for this box.

fileCountinteger

File count for this box.

fieldsobject required

Custom field values indexed by field key; each value follows its pipeline field type. Null values are omitted.

fieldsAutofillStatusobject nullable

AI autofill progress indexed by field key.

keystring required

Unique key identifying this box.

freshnessnumber double

Age score calculated as 1 / (0.3 times days since last activity + 1).

Example response

{
  "lastSavedTimestamp": 1646870400000,
  "creationTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000,
  "lastEmailUpdatedTimestamp": 1646870400000,
  "lastStageChangeTimestamp": 1646870400000,
  "lastCommentTimestamp": 1646870400000,
  "firstEmailTimestamp": 1646870400000,
  "firstEmailSentTimestamp": 1646870400000,
  "firstEmailReceivedTimestamp": 1646870400000,
  "lastEmailSentTimestamp": 1646870400000,
  "lastEmailReceivedTimestamp": 1646870400000,
  "contacts": [
    {
      "autoboxingTimestamp": 1646870400000
    }
  ],
  "organizations": [
    {
      "autoboxingTimestamp": 1646870400000
    }
  ],
  "soonestTaskDueDate": 1646870400000,
  "earliestOverdueTaskDueDate": 1646870400000,
  "mostRecentCallLogTimestamp": 1646870400000,
  "mostRecentMeetingNotesTimestamp": 1646870400000,
  "firstEventTimestamp": 1646870400000,
  "lastEventTimestamp": 1646870400000,
  "nextEventTimestamp": 1646870400000,
  "mostRecentLastSentEmailViewsTimestamp": 1646870400000,
  "mostRecentLastSentEmailLinkClickedTimestamp": 1646870400000,
  "mostRecentSentEmailsViewsTimestamp": 1646870400000,
  "firstCallLogTimestamp": 1646870400000,
  "firstMeetingNotesTimestamp": 1646870400000,
  "lastTouchpointTimestamp": 1646870400000,
  "stageHistoryEntries": [
    {
      "lastEntryToStageTs": 1646870400000
    }
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      endpoint added