The Customer organization category object type represents a customer organization category in third parties. atlassian:customer-org-category should be used to ingest customer organization category-specific fields.

Additional required fields for Customer-Org-Category:

displayName - Required

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ owners (List<userReference>) [Optional]
  └─ thumbnail (Thumbnail) [Optional]
  └─ parentKey (EntityKey) [Optional]
  └─ containerKey (EntityKey) [Optional]
  └─ permissions [] [Required]
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []

  atlassian:customer-org-category
  ├─ key (string) [Optional]
  └─ categoryType (string) [Optional]

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`userReference`	No	A reference to the user that created the object. See userReference to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`userReference`	No	A reference to the user that last updated the object. See userReference to learn more.
`owners`	`list<userReference>`	No	List of references of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	No	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Customer organization category properties

Property Type Required Description

Property	Type	Required	Description
`key`	`string`	No	The key of this customer organization category. Max length: 255
`categoryType`	`string`	No	The type of this customer organization category. Max length: 255

key

string

The key of this customer organization category.

Max length: 255

categoryType

string

The type of this customer organization category.

Max length: 255

Example payload

1
2
{
  "objects" : [ {
    "id" : "customer-org-category-example-1",
    "updateSequenceNumber" : 1,
    "displayName" : "CustomerOrgCategory noun example",
    "url" : "https://www.atlassian.com/share/customer-org-category",
    "createdAt" : "2024-07-09T14:27:37.000Z",
    "lastUpdatedAt" : "2024-07-09T14:27:37.000Z",
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "lastUpdatedBy" : {
      "externalId" : "external-id-2"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "EVERYONE"
        } ]
      } ]
    } ],
    "atlassian:customer-org-category" : {
      "key" : "category key",
      "categoryType" : "category type"
    }
  } ]
}