STstreakyc
Boxes

Update pipeline boxes

Changed on

Updates the supplied boxes in a pipeline. Every box must exist and be editable by the current user.

post/v2/pipelines/{pipelineKey}/boxes/batch/update

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/pipelines/{pipelineKey}/boxes/batch/update
  • 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 nullable

Box name. Empty or omitted values leave the name unchanged.

pipelineKeystring nullable

Destination pipeline key when moving a box.

boxKeystring required

Key of the box to update.

Response

OK

Example response

{
  "results": [
    {
      "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

  • ece69aa69a9dRevision 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

  • 821356952e07Revision changes
    • info

      endpoint added