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

Additional required fields for Customer-Org:

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
  ├─ contacts (List<userReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ customerOrgLastActivity (CustomerOrgLastActivity) [Optional]
      ├─ lastActivityAt (Instant (ISO8601 / RFC3339)) [Required]
      └─ event (string) [Required]
  ├─ customerOrgLifeTimeValue (CustomerOrgLifeTimeValue) [Optional]
      ├─ value (Double) [Required]
      └─ currencyCode (string) [Required]
  ├─ websiteUrl (string) [Optional]
  ├─ industry (string) [Optional]
  ├─ contributors (List<userReference>) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ country (string) [Optional]
  ├─ accountType (string) [Optional]
  ├─ key (string) [Optional]
  ├─ status (string) [Optional]
  ├─ address (string) [Optional]
  ├─ primaryContactUser (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  ├─ customerSegment (string) [Optional]
  ├─ entitlements (List<CustomerOrgEntitlement>) [Optional]
  └─ entityExtendedValues (List<EntityExtendedValue>) [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 properties

Property	Type	Required	Description
`contacts`	`List<userReference>`	No	List of references to contact persons for the customer organization.
`customerOrgLastActivity`	`CustomerOrgLastActivity`	No	Information about the last activity for the customer organization.
`customerOrgLastActivity.lastActivity`	`string`	Yes	The timestamp of the last activity. Format: Instant (ISO8601 / RFC3339)
`customerOrgLastActivity.event`	`string`	Yes	The type of the last activity event.
`customerOrgLifeTimeValue`	`CustomerOrgLifeTimeValue`	No	The lifetime value information for the customer organization.
`customerOrgLifeTimeValue.value`	`double`	Yes	The monetary value of the customer lifetime value.
`customerOrgLifeTimeValue.currencyCode`	`string`	Yes	The currency code for the lifetime value (e.g., USD, EUR).
`websiteUrl`	`string`	No	The website URL of the customer organization.
`industry`	`string`	No	The industry sector of the customer organization. Max length: 255
`contributors`	`List<userReference>`	No	List of references to contributors associated with the customer organization.
`country`	`string`	No	The country where the customer organization is located. Max length: 255
`accountType`	`string`	No	The type of account for the customer organization. Max length: 255
`key`	`string`	No	The key of the customer organization. Max length: 255
`status`	`string`	No	The status of the customer organization. Max length: 255
`address`	`string`	No	The address of the customer organization.
`primaryContactUser`	`userReference`	No	The primary contact user for the customer organization.
`customerSegment`	`string`	No	The segment of the customer organization, e.g. Enterprise, SMB.
`entitlements`	`List<CustomerOrgEntitlement>`	No	The entitlements of the customer organization.
`entityExtendedValues`	`List<EntityExtendedValue>`	No	The entity extended values that might be indexed and leveraged in search and filtering.

Example payload

1
2
{
  "objects" : [ {
    "id" : "customer-org-1",
    "updateSequenceNumber" : 1,
    "displayName" : "Customer Organization Name",
    "description" : "A description of the customer organization.",
    "url" : "https://customer-org.example.com",
    "createdAt" : "2024-04-16T09:31:32+00:00",
    "lastUpdated" : "2024-04-16T09:31:32+00:00",
    "lastUpdatedBy" : {
      "externalId" : "external-id-1"
    },
    "createdBy" : {
      "externalId" : "external-id-1"
    },
    "owners" : [ {
      "externalId" : "external-id-1"
    } ],
    "thumbnail" : {
      "url" : "http://example-app.com/thumbnail-url",
      "mimeType" : "image/png"
    },
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:customer-org" : {
      "contacts" : [ {
         "externalId" : "external-id-1"
      } ],
      "lastActivity" : {
        "lastActivityAt" : "2023-05-01T05:00:45Z",
        "event" : "delete"
      },
      "lifeTimeValue" : {
        "value" : 1000000.0,
        "currencyCode" : "USD"
      },
      "websiteUrl" : "https://customer-org.example.com",
      "industry" : "Technology",
      "contributors" : [ {
        "externalId": "123123456"
      } ],
      "country" : "USA",
      "accountType" : "Bronze"
    }
  } ]
}