Atlassian · Example Payload

Atlassian Atlassianaddonpropertiesresourceputaddonpropertyput Example

CodeCollaborationPlatformProductivitySoftware Development

Atlassian Atlassianaddonpropertiesresourceputaddonpropertyput Example is an example object payload from Atlassian, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "atlassianAddonpropertiesresourcePutaddonpropertyPut",
  "method": "PUT",
  "path": "/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}",
  "summary": "Atlassian Set App Property",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "message": "Property updated.",
        "statusCode": 200
      }
    },
    {
      "status": "201",
      "contentType": "application/json",
      "example": {
        "message": "Property created.",
        "statusCode": 201
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "example": {
        "message": "The property key cannot be longer than 127 characters.",
        "statusCode": 400
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "message": "Access to this resource must be authenticated as an app.",
        "statusCode": 401
      }
    }
  ]
}