Sprint

Set property

Changed on Jul 13, 2026

Sets the value of the specified sprint's property.

You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.

put/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}

Request

Base URL
https://your-domain.atlassian.net
URL
https://your-domain.atlassian.net/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}
Auth
- HTTP basic
- or OAuth 2
  Authorization code: https://auth.atlassian.com/authorize
  Token URL: https://auth.atlassian.com/oauth/token scopes: write:sprint:jira-software
- or none

Path parameters

sprintIdstring required

the ID of the sprint on which the property will be set.

propertyKeystring required

the key of the sprint's property. The maximum length of the key is 255 bytes.

Request body

unknown required

Response

Returned if the sprint property is successfully updated.