v1

latestOpenAPI 3.1.02026-07-1451089.2 KB

Create a box

This call creates a box based on the pipelineKey you provide.

post/pipelines/{pipelineKey}/boxes

Path parameters

pipelineKeystring required

The key of the pipeline this box should belong to

Request body

namestring required

The name of this box

stageKeystring

The stage of this box

notesstring

The notes on the box

assignedToSharingEntriesstring

The member(s) of your team this box will be assigned to. This must be an array of objects with email properties encoded as a JSON string. Try this as an example: [{"email":"ginny@weasley.com"}, {"email":"fred@weasley.com"}, {"email":"george@weasley.com"}]', keeping in mind that any assigned-to users must have access to the pipeline.

Response

200

pipelineKeystring

creatorKeystring

creationTimestampinteger

lastUpdatedTimestampinteger

namestring

stageKeystring

fieldsobject

followerKeysstring[]

followerCountinteger

commentCountinteger

taskTotalinteger

gmailThreadCountinteger

fileCountinteger

boxKeystring

keystring

Example response

{
  "pipelineKey": "agptYWl3cYPww",
  "creatorKey": "agptXNlchgBDA",
  "creationTimestamp": 1348436318347,
  "lastUpdatedTimestamp": 1348436318347,
  "name": "NewBox",
  "stageKey": "5001",
  "followerKeys": [
    "agptXNlchgBDA"
  ],
  "followerCount": 1,
  "gmailThreadCount": 1,
  "boxKey": "agptYWRiZAQw",
  "key": "agptYWRiZAQw"
}