Update a box

post

https://api.streak.com/api/v1/boxes/{boxKey}

This call lets you edit the properties of a box.

Path Params

boxKey

string

required

The key of the box you'd like to update

Body Params

name

string

The new name of the box

notes

string

The notes of the box

stageKey

string

The key of the stage that this box should be in. A list of valid stage keys can be found from the pipeline that this box belongs to

followerKeys

array of strings

A JSON array of user keys who are following this box. When a user follows a box, they receive notification emails upon major changes to the box

followerKeys

linkedBoxKeys

array of strings

The list of box keys you would like to link to the current box.

linkedBoxKeys

assignedToSharingEntries

array of strings

List of the keys of users assigned to the box. You can unassign a box by sending an empty array.

assignedToSharingEntries

contacts

array of objects

The only contacts associated with the box will be the ones you include here; make sure to include any previously associated contacts as well as the new one(s).

contacts

organizations

array of objects

The only organizations associated with the box will be the ones you include here; make sure to include any previously associated organizations as well as the new one(s).

organizations

fields

json

Field keys and corresponding values, e.g. { "1007": "String", "1039": 42}

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400