Update a box

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

This call lets you edit the properties of a box.

The post data for this request must be a well formed JSON object. The properties of the JSON object determine what properties of the box get updated. The above are the allowable properties for that JSON object. All other properties will be ignored.

📘
Updating field and stages properties
To change the fields or the stages property, you must use different endpoints. The fields and stages are only provided as a convenience here. The necessary endpoints are specified in the Field and Stage section of this document.
Note: if updating contacts or organizations, you can do so using this API endpoint.

🚧
Content Type and Auth
Make sure to include -H "Content-Type: application/json" and your authorization in any request you make on your own.

🚧
Only those you list in your arrays will be associated with your box!
In other words, if you're adding assigned to/contacts/organizations to a box that already has them (and you don't want to remove them), you'll have to send previous objects up along with this call, as well.

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


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.streak.com/api/v1/boxes/boxKey \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

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

application/json

Update a box

📘
Updating field and stages properties

🚧
Content Type and Auth

🚧
Only those you list in your arrays will be associated with your box!

📘Updating field and stages properties

🚧Content Type and Auth

🚧Only those you list in your arrays will be associated with your box!

200200

400400

📘
Updating field and stages properties

🚧
Content Type and Auth

🚧
Only those you list in your arrays will be associated with your box!