---
updatedAt: 2025-06-09T22:06:20.000Z
agentTools:
  projectIndex: https://streak.readme.io/llms.txt
---

# Update a box

This call lets you edit the properties of a [box](reference#get-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.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "streak-v1",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.streak.com/api/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/boxes/{boxKey}": {
      "post": {
        "summary": "Update a box",
        "description": "This call lets you edit the properties of a [box](reference#get-a-box).",
        "operationId": "edit-a-box",
        "parameters": [
          {
            "name": "boxKey",
            "in": "path",
            "description": "The key of the box you'd like to update",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The new name of the box"
                  },
                  "notes": {
                    "type": "string",
                    "description": "The notes of the box"
                  },
                  "stageKey": {
                    "type": "string",
                    "description": "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": {
                    "type": "array",
                    "description": "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",
                    "items": {
                      "type": "string"
                    }
                  },
                  "linkedBoxKeys": {
                    "type": "array",
                    "description": "The list of box keys you would like to link to the current box.",
                    "items": {
                      "type": "string"
                    }
                  },
                  "assignedToSharingEntries": {
                    "type": "array",
                    "description": "List of the keys of users assigned to the box. You can unassign a box by sending an empty array.",
                    "items": {
                      "type": "string"
                    }
                  },
                  "contacts": {
                    "type": "array",
                    "description": "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).",
                    "items": {
                      "properties": {
                        "key": {
                          "type": "string",
                          "description": "Contact key"
                        },
                        "isAutoboxed": {
                          "type": "boolean",
                          "description": "Determines if the contact has autoboxing enabled"
                        },
                        "isStarred": {
                          "type": "boolean",
                          "description": "Determines if the contact is \"starred\" in our interface"
                        }
                      },
                      "required": [
                        "key",
                        "isStarred"
                      ],
                      "type": "object"
                    }
                  },
                  "organizations": {
                    "type": "array",
                    "description": "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).",
                    "items": {
                      "properties": {
                        "key": {
                          "type": "string",
                          "description": "Organization key"
                        },
                        "isAutoboxed*": {
                          "type": "boolean",
                          "description": "Determines if the organization has autoboxing enabled"
                        },
                        "isStarred": {
                          "type": "boolean",
                          "description": "Determines if the organization is \"starred\" in our interface"
                        }
                      },
                      "required": [
                        "key",
                        "isStarred"
                      ],
                      "type": "object"
                    }
                  },
                  "fields": {
                    "type": "string",
                    "description": "Field keys and corresponding values, e.g. { \"1007\": \"String\", \"1039\": 42}",
                    "format": "json"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"pipelineKey\": \"agptYWl3cYPww\",\n  \"creatorKey\": \"agptXNlchgBDA\",\n  \"creationTimestamp\": 1348436318347,\n  \"lastUpdatedTimestamp\": 1348436318347,\n  \"name\": \"NewBox\",\n  \"stageKey\": \"5001\",\n  \"fields\": {},\n  \"followerKeys\": [\"agptXNlchgBDA\"],\n  \"followerCount\": 1,\n  \"commentCount\": 0,\n  \"taskTotal\": 0,\n  \"gmailThreadCount\": 1,\n  \"fileCount\": 0,\n  \"boxKey\": \"agptYWRiZAQw\",\n  \"key\": \"agptYWRiZAQw\"\n}  "
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "pipelineKey": {
                      "type": "string",
                      "example": "agptYWl3cYPww"
                    },
                    "creatorKey": {
                      "type": "string",
                      "example": "agptXNlchgBDA"
                    },
                    "creationTimestamp": {
                      "type": "integer",
                      "example": 1348436318347,
                      "default": 0
                    },
                    "lastUpdatedTimestamp": {
                      "type": "integer",
                      "example": 1348436318347,
                      "default": 0
                    },
                    "name": {
                      "type": "string",
                      "example": "NewBox"
                    },
                    "stageKey": {
                      "type": "string",
                      "example": "5001"
                    },
                    "fields": {
                      "type": "object",
                      "properties": {}
                    },
                    "followerKeys": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "example": "agptXNlchgBDA"
                      }
                    },
                    "followerCount": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "commentCount": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "taskTotal": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "gmailThreadCount": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "fileCount": {
                      "type": "integer",
                      "example": 0,
                      "default": 0
                    },
                    "boxKey": {
                      "type": "string",
                      "example": "agptYWRiZAQw"
                    },
                    "key": {
                      "type": "string",
                      "example": "agptYWRiZAQw"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```