{"openapi":"3.0.0","info":{"title":"Atlassian CSM API","version":"1.0.0"},"tags":[{"name":"Organization","description":"This resource represents organizations. Use this to manage an organization, profile, detail fields and values, entitlements and customers they have."},{"name":"Organization bulk operations","description":"This resource represents bulk operations for organizations. Use this to perform bulk operations on organizations, including their profiles and detail fields and values."},{"name":"Customer","description":"This resource represents customers. Use this to manage a customer account, profile, detail fields and values, entitlements and organizations they are a member of."},{"name":"Customer bulk operations","description":"This resource represents bulk operations for customers. Use this to perform bulk operations on customer accounts, profiles, and detail fields and values."},{"name":"Product","description":"This resource represents products."},{"name":"Entitlement","description":"This resource represents entitlements, including their details. Use this to manage entitlement detail fields and values."},{"name":"CSM Request","description":"This resource represents CSM requests. Use this to create requests from external systems via the intake channel."},{"name":"Task","description":"This resource represents tasks. Use this to manage viewing the status of tasks."}],"components":{"responses":{"BadRequest":{"description":"Returned if the request is sent with malformed or invalid data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}},"Unauthenticated":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}},"Forbidden":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}},"NotFound":{"description":"Returned if the resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}},"PreconditionFailed":{"description":"Returned if a required header was not set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}},"InternalError":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestError"}}}}},"schemas":{"Organization":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for organization.","example":"123"},"name":{"type":"string","description":"The name of the organization.","example":"Atlassian"},"details":{"type":"array","items":{"$ref":"#/components/schemas/DetailField"}}},"required":["id","name","details"]},"Customer":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the customer, in the form of an Atlassian Account Identifier (AAID).","example":"2a927c94-363f-4977-a0d6-9477d535f329"},"name":{"type":"string","description":"The name of the customer.","example":"John Doe"},"details":{"type":"array","items":{"$ref":"#/components/schemas/DetailField"}},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/CustomerOrganization"}}},"required":["id","name","details"]},"CustomerProfile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the customer, in the form of an Atlassian Account Identifier (AAID).","example":"2a927c94-363f-4977-a0d6-9477d535f329"},"name":{"type":"string","description":"The name of the customer.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer. Only visible to site administrators.","example":"john.doe@example.com"}},"required":["id","name"]},"Product":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for product.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"},"name":{"type":"string","maxLength":200,"description":"The name of the product.","example":"Acme Widget"}},"required":["id","name"]},"EntitledEntity":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the entitled entity.","example":"123"},"type":{"type":"string","description":"The type of the entitled entity.","enum":["CUSTOMER","ORGANIZATION"],"example":"CUSTOMER"}},"required":["id","type"]},"Entitlement":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for entitlement.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"},"product":{"$ref":"#/components/schemas/Product"},"entitledEntity":{"$ref":"#/components/schemas/EntitledEntity"},"details":{"type":"array","items":{"$ref":"#/components/schemas/DetailField"}}},"required":["id","product","entitledEntity","details"]},"PaginatedProducts":{"type":"object","properties":{"results":{"type":"array","description":"A list of products","items":{"$ref":"#/components/schemas/Product"}},"nextPageCursor":{"type":"string","description":"Cursor for getting the next page of items. Use this as the value for the `cursor` query parameter to get the next page of results."}},"required":["results","hasNextPage"]},"CustomerOrganization":{"type":"object","description":"This represents the ID and name of the organizations which the individual are members of.","properties":{"id":{"type":"string","description":"The unique identifier for organization.","example":"123"},"name":{"type":"string","description":"The name of the organization.","example":"Atlassian"}}},"DetailFieldSavedValue":{"type":"array","description":"The value of the detail field, for the given entity. For example, if the field is a single-value field, then this array will contain a single value. If the field is a multi-value field, then this array will contain multiple values. Each value has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["EU"]},"DetailFieldOptions":{"type":"array","description":"Field value options if they are allowed for this type. Only available for type SELECT & MULTISELECT. Each option cannot contain a comma and has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["AU","EU","US"]},"DetailFieldType":{"type":"object","description":"Field type.","properties":{"name":{"type":"string","enum":["TEXT","EMAIL","URL","DATE","NUMBER","BOOLEAN","PHONE","SELECT","MULTISELECT"],"example":"SELECT"},"options":{"$ref":"#/components/schemas/DetailFieldOptions"}},"required":["name"]},"DetailFieldValue":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the detail field.","example":"321"},"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"},"type":{"$ref":"#/components/schemas/DetailFieldType"},"values":{"type":"array","description":"The value of the detail field, for the given entity. For example, if the field is a single-value field, then this array will contain a single value. If the field is a multi-value field, then this array will contain multiple values. Each value has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["EU"]}}},"DetailFieldDefinition":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"},"type":{"$ref":"#/components/schemas/DetailFieldType"}},"required":["name","type"]},"DetailFieldWithConfiguration":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"},"type":{"$ref":"#/components/schemas/DetailFieldType"},"configuration":{"$ref":"#/components/schemas/DetailFieldContextConfiguration"}},"required":["name","type","configuration"]},"DetailFieldsWithConfiguration":{"type":"object","properties":{"results":{"type":"array","description":"A list of detail fields","items":{"$ref":"#/components/schemas/DetailFieldWithConfiguration"}}},"required":["results"]},"DetailFieldContextConfiguration":{"type":"object","description":"Field configuration, i.e. position in the list of fields.","properties":{"position":{"type":"integer","description":"Field position in the list of all fields.","example":1}}},"DetailField":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the detail field.","example":"321"},"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"},"type":{"$ref":"#/components/schemas/DetailFieldType"},"values":{"type":"array","description":"The value of the detail field, for the given entity. For example, if the field is a single-value field, then this array will contain a single value. If the field is a multi-value field, then this array will contain multiple values. Each value has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["EU"]},"configuration":{"$ref":"#/components/schemas/DetailFieldContextConfiguration"}}},"CreateDetailFieldRequest":{"description":"The structure of the detail field to create","type":"object","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`. The name cannot be exactly the following reserved keywords (case ignored) - **Name**, **Key**, **Created**, **Updated**, **Label**.\n","example":"Region"},"type":{"$ref":"#/components/schemas/DetailFieldType"}},"required":["name","type"]},"CreateDetailFieldResponse":{"type":"object","description":"Returns the created detail field","$ref":"#/components/schemas/DetailFieldDefinition"},"EditDetailFieldRequest":{"type":"object","description":"The new name of the detail field and, for types SELECT & MULTISELECT only, the new detail field value options.","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`. The name cannot be exactly the following reserved keywords (case ignored) - **Name**, **Key**, **Created**, **Updated**, **Label**.\n","example":"Region"},"options":{"$ref":"#/components/schemas/DetailFieldOptions"}},"required":["name"]},"EditDetailFieldResponse":{"type":"object","description":"Returns the edited detail field.","$ref":"#/components/schemas/DetailFieldDefinition"},"CustomerSearchByDetailFieldRequest":{"type":"object","properties":{"detailFields":{"type":"array","items":{"$ref":"#/components/schemas/SearchDetailField"}}},"required":["detailFields"]},"SearchDetailField":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"CustomerSearchByDetailFieldResponse":{"type":"object","properties":{"page":{"type":"integer"},"maxResults":{"type":"integer"},"total":{"type":"integer"},"isLast":{"type":"boolean"},"customers":{"type":"array","items":{"$ref":"#/components/schemas/CustomerProfile"}}}},"UpdateDetailFieldRequest":{"type":"object","properties":{"values":{"type":"array","description":"The value to set. If the field is a single-value field, then this array should contain only a single value. If the field is a multi-value field, then this array should contain all the values to set. To delete the value, the array should be empty or contain an empty string.","items":{"type":"string","maxLength":255},"example":["EU"]}}},"UpdateDetailFieldResponse":{"type":"object","description":"Returns the updated field.","$ref":"#/components/schemas/DetailFieldValue"},"BulkDetailFieldOperation":{"type":"object","description":"An operation to perform on a customer detail field.","properties":{"operationType":{"type":"string","enum":["UPDATE","PATCH","DELETE"],"description":"The type of operation to perform:\n- UPDATE: Replace the entire value of the detail field.\n- PATCH: Add or append values to a MULTISELECT field.\n- DELETE: Delete the value of a detail field.\n","example":"UPDATE"},"payload":{"type":"object","description":"The payload containing the field operation details.","properties":{"name":{"type":"string","maxLength":255,"description":"The name of the detail field.","example":"Region"},"values":{"type":"array","items":{"type":"string"},"description":"The values for the detail field. Required for UPDATE and PATCH operations, not used for DELETE.","example":["Asia"]}},"required":["name"]}},"required":["operationType","payload"]},"BulkCustomerDetailFieldOperation":{"type":"object","description":"A customer and their detail field operations.","properties":{"customerId":{"type":"string","description":"The unique identifier for the customer, in the form of an Customer Account Identifier.","example":"qm:82a83bc1-d19a-4220-b388-af3f7d92165d:a495e659-5978-402f-a878-636e415ba1c1"},"operations":{"type":"array","description":"List of operations to perform on this customer's detail fields.","items":{"$ref":"#/components/schemas/BulkDetailFieldOperation"}}},"required":["customerId","operations"]},"BulkCustomerDetailFieldRequest":{"type":"object","description":"Request to perform bulk operations on customer detail fields.","properties":{"customers":{"type":"array","description":"List of customers and their detail field operations.","items":{"$ref":"#/components/schemas/BulkCustomerDetailFieldOperation"}}},"required":["customers"]},"ProductRequest":{"type":"object","description":"The name of the product to create.","properties":{"name":{"type":"string","maxLength":200,"description":"The name of the product.","example":"Acme Widget"}},"required":["name"]},"EntitlementRequest":{"type":"object","description":"The product ID of the product associated with the new entitlement, in the form of a UUID.","properties":{"productId":{"type":"string","description":"The unique identifier for product.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}},"required":["productId"]},"OrganizationCreateRequest":{"type":"object","description":"Request payload for organization create.","properties":{"name":{"type":"string","description":"The name of the organization to be created. This must be no more than 200 characters.","example":"Atlassian"}},"required":["name"]},"OrganizationUpdateRequest":{"type":"object","description":"Request payload for organization update.","properties":{"name":{"type":"string","description":"The updated name of the organization. This must be no more than 200 characters.","example":"Atlassian"}},"required":["name"]},"BulkOrganizationRequest":{"type":"object","properties":{"organizations":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/BulkOrganizationOperationRequest"}}},"required":["organizations"]},"BulkOrganizationOperationRequest":{"type":"object","description":"A single operation in the bulk organization request.","properties":{"operationType":{"type":"string","enum":["CREATE","UPDATE"],"example":"CREATE"},"payload":{"$ref":"#/components/schemas/OrganizationOperationRequest"}},"required":["operationType","payload"]},"OrganizationOperationRequest":{"type":"object","description":"Payload for managing a single organization in bulk operation. The id must be provided for update operations.","properties":{"id":{"type":"string","description":"The unique identifier for the organization.","example":"1"},"name":{"type":"string","description":"The name of the organization. This must be no more than 200 characters.","example":"Atlassian"}},"required":["name"]},"CustomersInOrganizationResponse":{"type":"object","properties":{"page":{"type":"integer","description":"The page for this request."},"limit":{"type":"integer","description":"The limit applied to the request."},"hasNext":{"type":"boolean","description":"Whether there is a subsequent page available to request."},"customerIds":{"type":"array","items":{"type":"string","description":"The unique identifier for the customer."},"example":["qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053","qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4"]}}},"CustomerAccount":{"type":"object","properties":{"displayName":{"type":"string","description":"The display name of the customer.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"}},"required":["displayName"]},"CustomerCreateRequest":{"type":"object","description":"Request payload for customer create. The email will be used as the displayName if none is provided.","properties":{"displayName":{"type":"string","description":"The name of the customer. If no displayName is provided, the email will be used.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"}},"required":["email"]},"CreatedCustomerAccount":{"type":"object","properties":{"customerId":{"type":"string","description":"The unique identifier for the customer.","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"},"displayName":{"type":"string","description":"The name of the customer. If no displayName is provided, the email will be used.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"}},"required":["customerId","displayName"]},"CustomerUpdateRequest":{"type":"object","properties":{"displayName":{"type":"string","description":"The updated name of the customer."}},"required":["displayName"]},"UpdatedCustomerAccount":{"type":"object","properties":{"displayName":{"type":"string","description":"The updated name of the customer.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"}},"required":["displayName"]},"BulkCustomerAccountRequest":{"type":"object","properties":{"customerAccounts":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/BulkCustomerAccountOperationRequest"}}},"required":["customerAccounts"]},"BulkCustomerAccountOperationRequest":{"type":"object","description":"A single operation in the bulk account request.","properties":{"operationType":{"type":"string","enum":["CREATE","UPDATE"],"example":"CREATE"},"payload":{"$ref":"#/components/schemas/CustomerAccountOperationRequest"}},"required":["operationType","payload"]},"CustomerAccountOperationRequest":{"type":"object","description":"Payload for managing a single customer account in bulk operation. Email must be provided for create operations. Either email or customerId is required to identify the customer for an update operation. If no displayName is provided for the create operation, the email will be used.","properties":{"displayName":{"type":"string","description":"The name of the customer. If no displayName is provided, the email will be used."},"email":{"type":"string","format":"email","description":"The email address of the customer to create or update."},"customerId":{"type":"string","description":"The unique identifier for the customer."}}},"AssociateCustomers":{"type":"object","properties":{"customerIds":{"type":"array","description":"The unique identifiers of the customers to add to the organization.\n","items":{"maxItems":25,"type":"string"},"example":["qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053","qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4"]}}},"OrganizationProfileCreateRequest":{"type":"object","description":"Request payload for organization profile create.","properties":{"name":{"type":"string","description":"The name of the organization. This must be no more than 200 characters.","example":"Atlassian"},"details":{"type":"array","description":"The detail field values to add for the new organization.","items":{"$ref":"#/components/schemas/ProfileDetailFieldValueRequest"}},"associateCustomers":{"$ref":"#/components/schemas/AssociateCustomers"},"associateProducts":{"$ref":"#/components/schemas/AssociateProducts"}},"required":["name"]},"OrganizationProfile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the organization.","example":"1"},"name":{"type":"string","description":"The name of the organization.","example":"Atlassian"},"details":{"type":"array","description":"The organization's detail fields.","items":{"$ref":"#/components/schemas/ProfileDetailField"}},"entitlements":{"type":"array","description":"The entitlements associated with the organization. Note for create operations, this only includes the entitlements the organization was successfully associated with.","items":{"$ref":"#/components/schemas/ProfileEntitlementField"}},"customers":{"type":"array","description":"The customers associated to the organization. Note for create operations, this only includes the customer IDs the organization was successfully associated with.","items":{"$ref":"#/components/schemas/ProfileCustomerField"}}},"required":["id","name"]},"FetchOrganizationRequest":{"type":"object","description":"Request to fetch multiple organizations by ID or name. A maximum of 50 organizations are allowed in a single request. At least one of organizationIds or organizationNames must be present.","properties":{"organizationIds":{"type":"array","description":"List of unique organization identifiers to fetch.","items":{"type":"string","description":"Unique identifier for the organization.","example":"1"}},"organizationNames":{"type":"array","description":"List of unique organization names to fetch.","items":{"type":"string","description":"Unique name for the organization.","example":"Atlassian"}}},"example":{"organizationIds":["1","2"],"organizationNames":["Atlassian"]}},"FetchOrganizationResponse":{"type":"object","description":"Response containing the list of requested organizations.","properties":{"organizations":{"type":"array","description":"List of organizations.","maxItems":50,"items":{"$ref":"#/components/schemas/CustomerOrganization"}}},"required":["organizations"]},"FetchOrganizationProfilesRequest":{"type":"object","description":"Request to fetch multiple organization profiles by ID or name. There is a maximum of 25 organizations allowed in a single request. At least one of organizationIds or organizationNames must be present.","properties":{"organizationIds":{"type":"array","description":"List of unique organization identifiers whose profiles should be returned.","items":{"type":"string","description":"Unique identifier for the organization.","example":"1"}},"organizationNames":{"type":"array","description":"List of unique organization names whose profiles should be returned.","items":{"type":"string","description":"Unique name for the organization.","example":"Atlassian"}},"expand":{"type":"array","description":"Use expand to include additional information about organization profiles in the response. The expand options are:\n* `entitlements` - Returns the list of entitlements associated with each organization profile.\n","items":{"type":"string","enum":["entitlements"]},"example":["entitlements"]}},"example":{"organizationIds":["1","2"],"organizationNames":["Atlassian"]}},"OrganizationProfilesResponse":{"type":"object","description":"Response containing the list of requested profiles.","properties":{"profiles":{"type":"array","description":"List of organization profiles.","maxItems":25,"items":{"$ref":"#/components/schemas/OrganizationProfile"}}},"required":["profiles"]},"BulkManageOrganizationProfilePayload":{"type":"object","description":"Payload for managing a single organization profile in bulk operation. Either name or id is required to identify the organization. At least one of name, details, associateCustomers, or associateProducts must also be provided for organization updates.\n\n**Important:** When using UPSERT operation, if only id is provided and the organization does not exist, the operation will fail. To create a new organization with UPSERT, the name field must be provided.\n","properties":{"id":{"type":"string","description":"The unique identifier for the organization. Note: When using UPSERT operation, providing only id without name will not create a new organization if the organization does not exist - the operation will fail instead. The name is required to create new organization.\n","example":"1"},"name":{"type":"string","description":"The name of the organization. This must be no more than 200 characters.","example":"Atlassian"},"details":{"type":"array","description":"List of detail field updates for the organization.","items":{"$ref":"#/components/schemas/ProfileDetailFieldValueRequest"}},"associateCustomers":{"$ref":"#/components/schemas/AssociateCustomers"},"associateProducts":{"$ref":"#/components/schemas/AssociateProducts"}}},"BulkManageOrganizationProfileOperation":{"type":"object","description":"A single operation in the bulk manage request.","properties":{"operationType":{"type":"string","description":"The type of operation to perform:\n- CREATE: Creates a new organization profile. Fails if organization already exists.\n- UPDATE: Updates an existing organization profile. Fails if organization doesn't exist.\n- UPSERT: Creates a new organization if it doesn't exist, or updates if it does. Note: To create a new organization, name must be provided. When both id and name are provided, id takes precedence for identification.\n","enum":["CREATE","UPDATE","UPSERT"],"example":"UPSERT"},"payload":{"$ref":"#/components/schemas/BulkManageOrganizationProfilePayload"}},"required":["operationType","payload"]},"BulkManageOrganizationProfilesRequest":{"type":"object","description":"Request to bulk manage multiple organization profiles.","properties":{"organizationProfiles":{"type":"array","description":"List of organization profiles to manage. Maximum of 100 organization profiles can be sent per request.","maxItems":100,"items":{"$ref":"#/components/schemas/BulkManageOrganizationProfileOperation"}}},"required":["organizationProfiles"],"example":{"organizationProfiles":[{"operationType":"UPSERT","payload":{"name":"Atlassian","details":[{"name":"Region","values":["EMEA"]},{"name":"Phone Number","values":["0422333111"]}],"associateCustomers":{"customerIds":["qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053","qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4"]},"associateProducts":{"productIds":["3858a61a-d337-42e6-993e-e13e1c366d4f"]}}}]}},"BulkOrganizationDetailFieldOperation":{"type":"object","description":"An organization and their detail field operations.","properties":{"id":{"type":"string","description":"The unique identifier for the organization.","example":"1"},"operations":{"type":"array","description":"List of operations to perform on this organization's detail fields.","items":{"$ref":"#/components/schemas/BulkDetailFieldOperation"}}},"required":["id","operations"]},"BulkOrganizationDetailFieldRequest":{"type":"object","description":"Request to perform bulk operations on organization detail fields.","properties":{"organizations":{"type":"array","description":"List of organizations and their detail field operations.","items":{"$ref":"#/components/schemas/BulkOrganizationDetailFieldOperation"}}},"required":["organizations"]},"AssociateOrganizations":{"type":"object","properties":{"organizationIds":{"type":"array","description":"The ID of the organizations to add the customer to. A max of 5 organization identifiers can be provided. Note that this will not remove any organizations the customer is already added to.\n","maxItems":5,"items":{"type":"integer"},"example":[1,4,10,11,6]}}},"AssociateProducts":{"type":"object","properties":{"productIds":{"type":"array","description":"The ID of the products to add the customer or organization to. A max of 5 product identifiers can be provided. Note that this will not remove any products the customer or organization is already entitled to.\n","maxItems":5,"items":{"type":"string"},"example":["3858a61a-d337-42e6-993e-e13e1c366d4f","4858a61a-d337-42e6-993e-e13e1c366d4f"]}}},"CustomerProfileCreateRequest":{"type":"object","description":"Request payload for customer profile create. The email will be used as the displayName if none is provided.","properties":{"displayName":{"type":"string","description":"The name of the customer.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"details":{"type":"array","description":"The detail field values to add for the new customer.","items":{"$ref":"#/components/schemas/ProfileDetailFieldValueRequest"}},"associateOrganizations":{"$ref":"#/components/schemas/AssociateOrganizations"},"associateProducts":{"$ref":"#/components/schemas/AssociateProducts"}},"required":["email"]},"CustomerAccountProfile":{"type":"object","properties":{"customerId":{"type":"string","description":"The unique identifier for the customer.","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"},"displayName":{"type":"string","description":"The display name of the customer.","example":"John Doe"},"email":{"type":"string","description":"The email address of the customer.","example":"john.doe@example.com"},"organizations":{"type":"array","description":"The organizations the customer is in. Note for create operations, this only includes the organizations the customer was successfully added to.\n","items":{"$ref":"#/components/schemas/CustomerOrganization"}},"details":{"type":"array","description":"The customer's detail fields.","items":{"$ref":"#/components/schemas/ProfileDetailField"}},"entitlements":{"type":"array","description":"The entitlements associated with the customer. Note for create operations, this only includes the entitlements the customer was successfully associated with.","items":{"$ref":"#/components/schemas/ProfileEntitlementField"}}},"required":["customerId","displayName"]},"FetchCustomerProfilesRequest":{"type":"object","description":"Request to fetch multiple customer profiles by ID.","properties":{"customerIds":{"type":"array","description":"List of unique customer identifiers whose profiles should be returned.","maxItems":25,"items":{"type":"string","description":"Unique identifier for the customer.","example":"qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4"}},"expand":{"type":"array","description":"Use expand to include additional information about customer profiles in the response. The expand options are:\n* `entitlements` - Returns the list of entitlements associated with each customer profile.\n","items":{"type":"string","enum":["entitlements"]},"example":["entitlements"]}},"required":["customerIds"],"example":{"customerIds":["qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4","qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db5"]}},"CustomerProfilesResponse":{"type":"object","description":"Response containing the list of requested profiles.","properties":{"profiles":{"type":"array","description":"List of customer profiles.","maxItems":25,"items":{"$ref":"#/components/schemas/CustomerAccountProfile"}}},"required":["profiles"]},"ProfileDetailFieldValueRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"},"values":{"type":"array","description":"The value of the detail field, for the given entity. For example, if the field is a single-value field, then this array will contain a single value. If the field is a multi-value field, then this array can contain multiple values. Each value has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["EU"]}},"required":["name","values"]},"ProfileDetailFieldValue":{"type":"object","properties":{"type":{"type":"string","enum":["TEXT","EMAIL","URL","DATE","NUMBER","BOOLEAN","PHONE","SELECT","MULTISELECT"],"example":"SELECT"},"text":{"type":"array","description":"The value of the detail field, for the given entity. For example, if the field is a single-value field, then this array will contain a single value. If the field is a multi-value field, then this array will contain multiple values. Each value has a maximum length of 255.","items":{"type":"string","maxLength":255},"example":["EU"]}},"required":["type","text"]},"ProfileDetailField":{"type":"object","properties":{"name":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = \"`.\n","example":"Region"},"value":{"$ref":"#/components/schemas/ProfileDetailFieldValue"}},"required":["name","value"]},"ProfileEntitlementField":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for entitlement.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"},"product":{"$ref":"#/components/schemas/Product"},"entitledEntity":{"$ref":"#/components/schemas/EntitledEntity"},"details":{"type":"array","items":{"$ref":"#/components/schemas/ProfileDetailField"}}}},"ProfileCustomerField":{"type":"object","properties":{"id":{"type":"string","description":"The account id of the customer.","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"}}},"BulkManageCustomerProfilePayload":{"type":"object","description":"Payload for managing a single customer profile in bulk operation. Either email or customerId is required to identify the customer. At least one of displayName, details, associateOrganizations, or associateProducts must also be provided for customer updates.\n\n**Important:** When using UPSERT operation, if only customerId is provided and the customer does not exist, the operation will fail. To create a new customer with UPSERT, the email field must be provided.\n","properties":{"customerId":{"type":"string","description":"The unique identifier for the customer. Note: When using UPSERT operation, providing only customerId without email will not create a new customer if the customer does not exist - the operation will fail instead. Email is required to create new customers.\n","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"},"email":{"type":"string","description":"The email address of the customer.","example":"bob@example.com"},"displayName":{"type":"string","description":"The display name of the customer.","example":"Bob the builder"},"details":{"type":"array","description":"List of detail field updates for the customer.","items":{"$ref":"#/components/schemas/ProfileDetailFieldValueRequest"}},"associateOrganizations":{"$ref":"#/components/schemas/AssociateOrganizations"},"associateProducts":{"$ref":"#/components/schemas/AssociateProducts"}}},"BulkManageCustomerProfileOperation":{"type":"object","description":"A single operation in the bulk manage request.","properties":{"operationType":{"type":"string","description":"The type of operation to perform:\n- CREATE: Creates a new customer profile. Fails if customer already exists.\n- UPDATE: Updates an existing customer profile. Fails if customer doesn't exist.\n- UPSERT: Creates a new customer if it doesn't exist, or updates if it does. Note: To create a new customer, email must be provided. When both customerId and email are provided, customerId takes precedence for identification.\n","enum":["CREATE","UPDATE","UPSERT"],"example":"UPSERT"},"payload":{"$ref":"#/components/schemas/BulkManageCustomerProfilePayload"}},"required":["operationType","payload"]},"BulkManageCustomerProfilesRequest":{"type":"object","description":"Request to bulk manage multiple customer profiles.","properties":{"customerProfiles":{"type":"array","description":"List of customer profiles to manage. Maximum of 100 customer profiles can be sent per request.","maxItems":100,"items":{"$ref":"#/components/schemas/BulkManageCustomerProfileOperation"}}},"required":["customerProfiles"],"example":{"customerProfiles":[{"operationType":"UPSERT","payload":{"email":"john@example.com","displayName":"John Smith","details":[{"name":"Region","values":["EMEA"]},{"name":"Phone Number","values":["0422333111"]}],"associateOrganizations":{"organizationIds":[1,4]},"associateProducts":{"productIds":["3858a61a-d337-42e6-993e-e13e1c366d4f"]}}},{"operationType":"UPSERT","payload":{"email":"jane@example.com","displayName":"Jane Doe","details":[{"name":"Region","values":["EMEA"]}],"associateOrganizations":{"organizationIds":[3]},"associateProducts":{"productIds":["3858a61a-d337-42e6-993e-e13e1c366d4f","4858a61a-d337-42e6-993e-e13e1c366d4f"]}}}]}},"RestError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"The error message.","example":"Organization 1 does not exist"},"errors":{"type":"array","description":"A list of error keys associated with the error.","items":{"type":"string"},"example":["NOT_FOUND"]},"statusCode":{"type":"integer","description":"The http status returned with this error.","example":"404"}}},"ExternalFormIntakeRequest":{"type":"object","description":"Request to create a CSM request from an external intake channel","properties":{"helpCenterId":{"type":"string","description":"The unique identifier for the Help center.","example":"f17913e0-58f9-4be7-b6e6-a10ca70ccb55"},"origin":{"type":"string","description":"The identifier of the external system submitting the form.","example":"amazon-voice"},"summary":{"type":"string","description":"The summary of the CSM request.","example":"Unable to access application"},"description":{"type":"string","description":"The description of the CSM request.","example":"I am unable to login to the application. The error message says 'Invalid credentials'."},"reporterEmail":{"type":"string","format":"email","description":"Email address of the reporter. If not provided when using 2LO authentication, the request is created on behalf of the caller. For API token authentication, only agents can specify a reporter email.","example":"reporter@example.com"},"metadata":{"type":"object","description":"Optional metadata object containing additional context about the request. Only primitive values (string, int and boolean) are allowed as property values. Nested objects or arrays are not supported.","additionalProperties":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]},"example":{"agentId":"id","contactId":"id"}}},"required":["helpCenterId","origin","summary"]},"ExternalFormIntakeResponse":{"type":"object","description":"Response containing the created CSM request details","properties":{"id":{"type":"string","description":"The unique identifier of the created CSM request.","example":"f17913e0-58f9-4be7-b6e6-a10ca70ccb55"},"key":{"type":"string","description":"The unique identifier of the created issue.","example":"SD-123"},"helpCenterId":{"type":"string","description":"The unique identifier for the customer experience project.","example":"b84c574b-3b0e-49b5-a43b-718d74370de7"},"link":{"type":"string","description":"Direct link to view the created issue.","example":"https://example.atlassian.net/servicedesk/customer/portal/1/SD-123"}},"required":["id","key","helpCenterId","link"]},"TaskStatusResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the task.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"},"type":{"type":"string","description":"Type of task.\n- BULK_CUSTOMER_PROFILE_CREATE_UPDATE represents bulk management of customer profiles via the [Bulk manage multiple customer profiles API](../api-group-customer-bulk-operations/#api-api-v1-customer-profile-bulk-post).\n- BULK_CUSTOMER_ACCOUNT_CREATE_UPDATE represents bulk management of customer accounts via the [Bulk manage customer accounts API](../api-group-customer-bulk-operations/#api-api-v1-customer-bulk-post).\n- BULK_CUSTOMER_DETAIL represents bulk management of detail field values via the [Bulk manage customers' detail field values API](../api-group-customer-bulk-operations/#api-api-v1-customer-details-bulk-post).\n- BULK_ORGANIZATION_PROFILE_CREATE_UPDATE represents bulk management of organization profiles via the [Bulk manage multiple organization profiles API](../api-group-organization-bulk-operations/#api-api-v1-organization-profile-bulk-post).\n- BULK_ORGANIZATION_CREATE_UPDATE represents bulk management of organizations via the [Bulk manage organizations API](../api-group-organization-bulk-operations/#api-api-v1-organization-bulk-post).\n- BULK_ORGANIZATION_DETAIL represents bulk management of detail field values via the [Bulk manage organizations' detail field values API](../api-group-organization-bulk-operations/#api-api-v1-organization-details-bulk-post).\n","enum":["BULK_CUSTOMER_PROFILE_CREATE_UPDATE","BULK_CUSTOMER_ACCOUNT_CREATE_UPDATE","BULK_CUSTOMER_DETAIL","BULK_ORGANIZATION_PROFILE_CREATE_UPDATE","BULK_ORGANIZATION_CREATE_UPDATE","BULK_ORGANIZATION_DETAIL"],"example":"BULK_CUSTOMER_PROFILE_CREATE_UPDATE"},"status":{"type":"string","description":"Status of the task.","enum":["NOT_STARTED","IN_PROGRESS","FAILED","FINISHED","CANCELLED"],"example":"IN_PROGRESS"},"failures":{"type":"array","items":{"$ref":"#/components/schemas/TaskFailure"}},"createdAt":{"type":"string","format":"date-time","description":"Task creation timestamp.","example":"2025-01-15T11:12:13Z"},"updatedAt":{"type":"string","format":"date-time","description":"Task last update timestamp.","example":"2025-01-15T11:12:13Z"}},"required":["id","name","status","progress","createdAt","updatedAt"]},"TaskFailure":{"type":"object","properties":{"entity":{"type":"string","description":"The entity in the failed operation.","enum":["CUSTOMER","ORGANIZATION"]},"entityId":{"type":"string","description":"An identifier for the entity. For Customer entities, this may be the account id or email. For Organizations, it is the organization id.","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"},"operation":{"type":"string","description":"The type of operation that was attempted.","enum":["CREATE","UPDATE","UPSERT","PATCH","DELETE"]},"operatedOn":{"type":"string","description":"The subject of the failed operation.","enum":["CUSTOMER_ACCOUNT","ORGANIZATION","DETAIL_FIELD","ASSOCIATE_ORGANIZATION","ASSOCIATE_PRODUCT","ASSOCIATE_CUSTOMER"]},"operatedOnIds":{"type":"array","description":"An identifier for the subject of the operation. For DETAIL_FIELD, this will be the field name. For ASSOCIATE_ORGANIZATION, this will contain the organization ids that the entity could not be associated with. For ASSOCIATE_PRODUCT, this will contain the product ids that the entity could not be associated with. If the subject is a CUSTOMER_ACCOUNT or ORGANIZATION, the entityId property will have the relevant identifier. For ASSOCIATE_CUSTOMER, this will contain the customer ids that the entity could not be associated with.","items":{"type":"string"},"example":["Region"]},"error":{"type":"string","description":"An error message for the failure, if any.","example":"Invalid detail field"}},"required":["entity","entityId","operation","operatedOn"]},"TaskSubmitResponse":{"type":"object","properties":{"id":{"type":"string","description":"Task identifier.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"},"statusUrl":{"type":"string","description":"URL to check the status of the task.","example":"/api/v1/tasks/3858a61a-d337-42e6-993e-e13e1c366d4f"}},"required":["id","statusUrl"]},"IdempotencyKeyHeader":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier for the request, used to ensure the operation is idempotent.","example":"c748a424-1db8-47f9-8288-713cdb0407b5"},"ExperimentalHeader":{"type":"string","description":"Opt-in header required for experimental APIs","example":"opt-in"},"IssueCommentRequest":{"type":"object","description":"Comment to be added to the existing issue","properties":{"body":{"type":"object","description":"The JsonNode representation of the comment to be added.","example":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"type":"text","text":"This is a comment."}]}]}},"public":{"type":"boolean","description":"Flag to indicate whether the comment is public or internal. Default is false (internal).","example":false}},"required":["comment"]},"IssueCommentResponse":{"type":"object","description":"Response containing the info of the added comment","properties":{"id":{"type":"string","description":"The unique identifier of the comment added.","example":"f17913e0-58f9-4be7-b6e6-a10ca70ccb55"}},"required":["id"]}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.atlassian.com/authorize","tokenUrl":"https://auth.atlassian.com/oauth/token","scopes":{"read:organization:jira-service-management":"Allows the app to read organization information","write:organization:jira-service-management":"Allows the app to create and update organizations","delete:organization:jira-service-management":"Allows the app to delete organizations","read:organization.detail:jira-service-management":"Allows the app to read organization details","write:organization.detail:jira-service-management":"Allows the app to create and update details on an organization","read:organization.detail-field:jira-service-management":"Allows the app to read organization detail fields","write:organization.detail-field:jira-service-management":"Allows the app to create and update detail fields on an organization","delete:organization.detail-field:jira-service-management":"Allows the app to delete detail fields on an organization","read:organization:entitlement:jira-service-management":"Allows the app to read organization entitlements","write:organization:entitlement:jira-service-management":"Allows the app to create organization entitlements","read:customer:jira-service-management":"Allows the app to read customer information","write:customer:jira-service-management":"Allows the app to create and update customers","delete:customer:jira-service-management":"Allows the app to delete customers","read:customer.detail:jira-service-management":"Allows the app to read customer details","write:customer.detail:jira-service-management":"Allows the app to create and update details on a customer","read:customer.detail-field:jira-service-management":"Allows the app to read customer detail fields","write:customer.detail-field:jira-service-management":"Allows the app to create and update detail fields on a customer","delete:customer.detail-field:jira-service-management":"Allows the app to delete detail fields on a customer","read:customer:entitlement:jira-service-management":"Allows the app to read customer entitlements","write:customer:entitlement:jira-service-management":"Allows the app to create customer entitlements","read:product:jira-service-management":"Allows the app to read product information","write:product:jira-service-management":"Allows the app to create and update product information","delete:product:jira-service-management":"Allows the app to delete product information","read:entitlement:jira-service-management":"Allows the app to read entitlement information","write:entitlement:jira-service-management":"Allows the app to create and update entitlements","delete:entitlement:jira-service-management":"Allows the app to delete entitlements","read:entitlement.detail:jira-service-management":"Allows the app to read entitlement details","write:entitlement.detail:jira-service-management":"Allows the app to create and update details on an entitlement","read:entitlement.detail-field:jira-service-management":"Allows the app to read entitlement detail fields","write:entitlement.detail-field:jira-service-management":"Allows the app to create and update detail fields on an entitlement","delete:entitlement.detail-field:jira-service-management":"Allows the app to delete entitlement detail fields","read:task:jira-service-management":"Allows the app to read task information","write:csm-request:jira-service-management":"Allows the caller to create CSM requests via external intake channel"}}}}}},"paths":{"/api/v1/organization/details":{"get":{"summary":"Get organization detail fields","operationId":"get-all-organization-details","tags":["Organization"],"security":[{"OAuth2":["read:organization.detail-field:jira-service-management"]}],"description":"Returns all organization detail fields, including their configuration. You can use the [get organization profile](./#api-api-v1-organization-profile-organizationid-get) API to get details for a particular organization.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"200":{"description":"Returns a list of organization detail fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailFieldsWithConfiguration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create organization detail field","operationId":"create-organization-detail","tags":["Organization"],"security":[{"OAuth2":["write:organization.detail-field:jira-service-management"]}],"description":"Creates an organization detail field. You can create up to 50 detail fields. <br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the created detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/details/{fieldName}":{"parameters":[{"name":"fieldName","in":"path","description":"The name of the detail field to edit.","required":true,"schema":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"}}],"put":{"summary":"Edit organization detail field","operationId":"update-field-for-organizations","security":[{"OAuth2":["write:organization.detail-field:jira-service-management"]}],"tags":["Organization"],"description":"Renames an organization detail field and/or changes the available options for SELECT or MULTISELECT fields.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the edited organization detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete organization detail field","operationId":"delete-organization-detail","tags":["Organization"],"security":[{"OAuth2":["delete:organization.detail-field:jira-service-management"]}],"description":"Deletes an organization detail field and all values stored for it for all organizations. You cannot restore a detail field once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"204":{"description":"Returns no response if the organization detail field is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/{organizationId}":{"parameters":[{"name":"organizationId","description":"Unique identifier of organizations, must be positive integers only.","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for organization.","example":"123"}}],"get":{"summary":"Get organization","operationId":"get-organization","security":[{"OAuth2":["read:organization:jira-service-management","read:organization.detail:jira-service-management"]}],"tags":["Organization"],"description":"Returns an organization, including its details.\nIt is recommended to use the [get organization profile API](./#api-api-v1-organization-profile-organizationid-get) which is a simpler response shape to work with and also includes the entitlements for the organization.<br><br>\n**Permissions required:** Jira Service Management agent.\n","responses":{"200":{"description":"Returns the requested organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"summary":"Update organization","operationId":"update-organization","x-experimental":true,"security":[{"OAuth2":["write:organization:jira-service-management"]}],"tags":["Organization"],"description":"Updates an organization's name.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to update organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUpdateRequest"}}}},"responses":{"200":{"description":"Returns the updated organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOrganization"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete organization","operationId":"delete-organization","x-experimental":true,"security":[{"OAuth2":["delete:organization:jira-service-management"]}],"tags":["Organization"],"description":"Deletes an organization. You cannot restore an organization once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"204":{"description":"Returns no response if the organization is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/{organizationId}/details":{"parameters":[{"name":"organizationId","description":"Unique identifier of organizations, must be positive integers only.","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for organization.","example":"123"}}],"put":{"summary":"Set organization detail","operationId":"update-field-value-for-organizations","security":[{"OAuth2":["write:organization.detail:jira-service-management"]}],"tags":["Organization"],"description":"**Permissions required:** Jira Service Management agent.\n","parameters":[{"name":"fieldName","in":"query","description":"The name of the organization detail field to set the value of.","required":true,"schema":{"type":"string","example":"Region"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the updated field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/{organizationId}/entitlement":{"parameters":[{"name":"organizationId","description":"Unique identifier of organizations, must be positive integers only.","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for organization.","example":"123"}}],"get":{"summary":"Get organization entitlements","operationId":"get-organization-entitlements","security":[{"OAuth2":["read:organization:entitlement:jira-service-management"]}],"tags":["Organization"],"description":"Returns a list of the organization's entitlements, along with their details.<br><br>\n**Permissions required:** Jira Service Management agent.\n","parameters":[{"name":"product","in":"query","description":"A product ID to optionally filter the entitlements to just entitlements of that product.","required":false,"schema":{"type":"string","description":"The unique identifier for product, as a UUID.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"responses":{"200":{"description":"Returns a list of entitlements.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Entitlement"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create organization entitlement","operationId":"create-organization-entitlement","security":[{"OAuth2":["write:organization:entitlement:jira-service-management"]}],"tags":["Organization"],"description":"**Permissions required:** Jira Service Management agent.\n","requestBody":{"description":"The ID of the associated product, as a UUID.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementRequest"}}}},"responses":{"200":{"description":"Returns the created entitlement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlement"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization":{"post":{"summary":"Create organization","operationId":"create-organization","x-experimental":true,"security":[{"OAuth2":["write:organization:jira-service-management"]}],"tags":["Organization"],"description":"Creates an organization.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreateRequest"}}}},"responses":{"200":{"description":"Returns the created organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOrganization"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/fetch":{"post":{"summary":"Fetch multiple organizations","operationId":"get-multiple-organizations","x-experimental":true,"security":[{"OAuth2":["read:organization:jira-service-management"]}],"tags":["Organization"],"description":"Returns a maximum of 50 organizations, fetched by organization id or name.<br>\nAny organizations that cannot be found will be omitted from the results.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchOrganizationRequest"}}}},"responses":{"200":{"description":"Returns the requested organizations, if existing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchOrganizationResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/profile/{organizationId}":{"parameters":[{"name":"organizationId","in":"path","required":true,"description":"The unique identifier for the organization.","schema":{"type":"string","example":"1"}}],"get":{"summary":"Get organization profile","operationId":"get-organization-profile","x-experimental":true,"security":[{"OAuth2":["read:organization.profile:jira-service-management"]}],"tags":["Organization"],"description":"Returns a organization's profile, including its custom details and any product entitlements.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"200":{"description":"Returns the requested organization profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfile"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/profile":{"post":{"summary":"Create organization profile","operationId":"create-organization-profile","x-experimental":true,"security":[{"OAuth2":["write:organization.profile:jira-service-management"]}],"tags":["Organization"],"description":"Creates an organization's profile, including adding the organization's detail fields, customers belonging to the organization and any product entitlements.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfileCreateRequest"}}}},"responses":{"200":{"description":"Returns the created organization profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfile"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/profile/fetch":{"post":{"summary":"Fetch multiple organization profiles","operationId":"get-multiple-organization-profiles","x-experimental":true,"security":[{"OAuth2":["read:organization.profile:jira-service-management"]}],"tags":["Organization"],"description":"Returns a maximum of 25 organization profiles.<br>\nAny organizations that cannot be found will be omitted from the results.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchOrganizationProfilesRequest"}}}},"responses":{"200":{"description":"Returns the requested organization profiles, if existing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationProfilesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/profile/bulk":{"post":{"summary":"Bulk manage organization profiles","operationId":"bulk-manage-organization-profiles","x-experimental":true,"security":[{"OAuth2":["write:organization.profile:jira-service-management"]}],"tags":["Organization bulk operations"],"description":"Bulk manage multiple organization profiles with detail fields.<br>\nAllows creating, updating or upserting up to <b>100</b> organization profiles in a single request.<br><br>\n**Organization Identification:** To identify organizations, provide either `id` or `name`. When using UPSERT operation, note that providing only `id` (without `name`) will not create a new organization if the organization doesn't exist. The `name` field must be provided to create new organizations.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkManageOrganizationProfilesRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../api-group-task/#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/bulk":{"post":{"summary":"Bulk manage organizations","operationId":"bulk-manage-organizations","x-experimental":true,"security":[{"OAuth2":["write:organization:jira-service-management"]}],"tags":["Organization bulk operations"],"description":"Bulk manage multiple organizations. This allows up to <b>50</b> organizations in a single request.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user. Note: Permission to update organizations can be switched to users with the Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/) permission using the [Organization management](https://support.atlassian.com/jira-service-management-cloud/docs/manage-customer-organizations-using-jira-product-settings/) feature available in Jira Service Management product settings.\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkOrganizationRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/organization/details/bulk":{"post":{"summary":"Bulk manage organizations' detail field values","operationId":"bulk-manage-organization-details","x-experimental":true,"security":[{"OAuth2":["write:organization.detail:jira-service-management"]}],"tags":["Organization bulk operations"],"description":"Bulk manage organization detail field values for multiple organizations. Supports UPDATE, PATCH, and DELETE operations across multiple organizations and detail fields.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"description":"The bulk operations to perform on organization detail field values, defined per organization. Operations can be combined.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkOrganizationDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../api-group-task/#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/details":{"get":{"summary":"Get customer detail fields","operationId":"get-all-customer-details","tags":["Customer"],"security":[{"OAuth2":["read:customer.detail-field:jira-service-management"]}],"description":"Returns all customer detail fields, including their configuration. You can use the [get customer profile](./#api-api-v1-customer-profile-customerid-get)\nAPI to get details for a particular customer.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"200":{"description":"Returns list of detail fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailFieldsWithConfiguration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create customer detail field","operationId":"create-customer-detail","tags":["Customer"],"security":[{"OAuth2":["write:customer.detail-field:jira-service-management"]}],"description":"Creates a customer detail field. You can create up to 50 detail fields. <br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"description":"The structure of the detail field to create.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the newly created detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/details/{fieldName}":{"parameters":[{"name":"fieldName","in":"path","description":"The name of the detail field to edit.","required":true,"schema":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = \"`.\n","example":"Region"}}],"put":{"summary":"Edit customer detail field","operationId":"update-field-for-customers","security":[{"OAuth2":["write:customer.detail-field:jira-service-management"]}],"tags":["Customer"],"description":"Renames a customer detail field and/or changes the available options for SELECT or MULTISELECT fields.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the edited customer detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete customer detail field","operationId":"delete-customer-detail","tags":["Customer"],"security":[{"OAuth2":["delete:customer.detail-field:jira-service-management"]}],"description":"Deletes a customer detail field and all values stored for it for all customers. You cannot restore a detail field once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"204":{"description":"Returns no response if the customer detail field is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/{customerId}":{"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for the customer, in the form of an Atlassian Account Identifier (AAID).","example":"2a927c94-363f-4977-a0d6-9477d535f329"}}],"get":{"summary":"Get customer","operationId":"get-customer","security":[{"OAuth2":["read:customer:jira-service-management","read:customer.detail:jira-service-management"]}],"tags":["Customer"],"description":"Returns a customer, including their details.\nIt is recommended to use the [get customer profile API](./#api-api-v1-customer-profile-customerid-get) which is a simpler response shape to work with and also includes the entitlements for the customer.<br><br>\n**Permissions required:** Jira Service Management agent.\n","responses":{"200":{"description":"Returns the requested customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/search-by-detail-field":{"post":{"summary":"Search customer by detail field and value","operationId":"search-by-detail-field","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"description":"The page number for pagination","example":1}},{"name":"maxResults","in":"query","required":false,"schema":{"type":"integer","default":1000,"description":"Maximum number of results per page","example":50}}],"security":[{"OAuth2":["read:customer:jira-service-management"]}],"tags":["Customer"],"description":"Returns the list of customers. You can get details and entitlements for a customer using [get customer profile](./#api-api-v1-customer-profile-customerid-get) API.<br><br>\n**Permissions required:** Jira Service Management agent.\nTo retrieve restricted information such as email address of the user, **Administer Jira** [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSearchByDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the list of customers that match the search criteria.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerSearchByDetailFieldResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/{customerId}/details":{"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for the customer, in the form of an Atlassian Account Identifier (AAID).","example":"2a927c94-363f-4977-a0d6-9477d535f329"}}],"put":{"parameters":[{"name":"fieldName","in":"query","description":"The name of the customer detail field to set the value of.","required":true,"schema":{"type":"string","example":"Region"}}],"summary":"Set customer detail","operationId":"update-field-value-for-customer","security":[{"OAuth2":["write:customer.detail:jira-service-management"]}],"tags":["Customer"],"description":"**Permissions required:** Jira Service Management agent.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the updated field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/{customerId}/entitlement":{"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for the customer, in the form of an Atlassian Account Identifier (AAID).","example":"2a927c94-363f-4977-a0d6-9477d535f329"}}],"get":{"summary":"Get customer entitlements","operationId":"get-customer-entitlements","security":[{"OAuth2":["read:customer:entitlement:jira-service-management"]}],"tags":["Customer"],"description":"Returns a list of the customer's entitlements, including entitlements inherited by any organizations the customer is in, along with their details.<br><br>\n**Permissions required:** Jira Service Management agent.\n","parameters":[{"name":"product","in":"query","description":"A product ID to optionally filter the entitlements to just entitlements of that product.","required":false,"schema":{"type":"string","description":"The unique identifier for product, as a UUID.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"responses":{"200":{"description":"Returns a list of entitlements.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Entitlement"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create customer entitlement","operationId":"create-customer-entitlement","security":[{"OAuth2":["write:customer:entitlement:jira-service-management"]}],"tags":["Customer"],"description":"**Permissions required:** Jira Service Management agent.\n","requestBody":{"description":"The ID of the associated product.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementRequest"}}}},"responses":{"200":{"description":"Returns the created entitlement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlement"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer":{"post":{"summary":"Create customer account","operationId":"create-customer","x-experimental":true,"security":[{"OAuth2":["write:customer:jira-service-management"]}],"tags":["Customer"],"description":"Creates a customer account.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCreateRequest"}}}},"responses":{"200":{"description":"Returns the created customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedCustomerAccount"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/account/{customerId}":{"parameters":[{"name":"customerId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for the customer.","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"}}],"get":{"summary":"Get customer account","operationId":"get-customer-account","x-experimental":true,"security":[{"OAuth2":["read:customer:jira-service-management"]}],"tags":["Customer"],"description":"Returns a customer's account information.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"200":{"description":"Returns the requested customer account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccount"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"summary":"Update customer account","operationId":"update-customer-account","x-experimental":true,"security":[{"OAuth2":["write:customer:jira-service-management"]}],"tags":["Customer"],"description":"Updates a customer account's display name.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerUpdateRequest"}}}},"responses":{"200":{"description":"Returns the updated customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatedCustomerAccount"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete customer account","operationId":"delete-customer-account","x-experimental":true,"security":[{"OAuth2":["delete:customer:jira-service-management"]}],"tags":["Customer"],"description":"Deletes a customer. You cannot restore a customer account once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"204":{"description":"Returns no response if the customer is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/profile/{customerId}":{"parameters":[{"name":"customerId","in":"path","required":true,"description":"The unique identifier for the customer.","schema":{"type":"string","example":"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"}}],"get":{"summary":"Get customer profile","operationId":"get-customer-profile","x-experimental":true,"security":[{"OAuth2":["read:customer.profile:jira-service-management"]}],"tags":["Customer"],"description":"Returns a customer's profile, including their custom details, any organizations the customer is in, and any customer entitlements.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"200":{"description":"Returns the requested customer profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccountProfile"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/profile":{"post":{"summary":"Create customer profile","operationId":"create-customer-profile","x-experimental":true,"security":[{"OAuth2":["write:customer.profile:jira-service-management"]}],"tags":["Customer"],"description":"Creates a customer's profile, including their custom details and associating them with the specified organizations and products.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), and Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProfileCreateRequest"}}}},"responses":{"200":{"description":"Returns the requested customer profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAccountProfile"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/profile/fetch":{"post":{"summary":"Fetch multiple customer profiles","operationId":"get-multiple-customer-profiles","x-experimental":true,"security":[{"OAuth2":["read:customer.profile:jira-service-management"]}],"tags":["Customer"],"description":"Returns a maximum of 25 customer profiles. This includes detail fields and any organizations the customer is in.<br>\nAny customer accounts that cannot be found will be omitted from the results.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCustomerProfilesRequest"}}}},"responses":{"200":{"description":"Returns the requested customer profiles, if existing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerProfilesResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/details/bulk":{"post":{"summary":"Bulk manage customers' detail field values","operationId":"bulk-update-customer-details","x-experimental":true,"security":[{"OAuth2":["write:customer.detail:jira-service-management"]}],"tags":["Customer bulk operations"],"description":"Bulk manage customer detail field values for multiple customers. Supports UPDATE, PATCH, and DELETE operations across multiple customers and detail fields.<br><br>\n**Permissions required:** Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"description":"The bulk operations to perform on customer detail field values, defined per customer. Operations can be combined.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCustomerDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../api-group-task/#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/bulk":{"post":{"summary":"Bulk manage customer accounts","operationId":"bulk-create-customer-accounts","x-experimental":true,"security":[{"OAuth2":["write:customer:jira-service-management"]}],"tags":["Customer bulk operations"],"description":"Bulk manage multiple customer accounts. This allows up to <b>50</b> customer accounts in a single request.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCustomerAccountRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../api-group-task/#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/customer/profile/bulk":{"post":{"summary":"Bulk manage multiple customer profiles","operationId":"bulk-manage-multiple-customer-profiles","x-experimental":true,"security":[{"OAuth2":["write:customer.profile:jira-service-management"]}],"tags":["Customer bulk operations"],"description":"Bulk manage multiple customer profiles with detail fields and organization associations.<br>\nAllows creating, updating or upserting up to <b>100</b> customer profiles in a single request.<br><br>\n**Customer Identification:** To identify customers, provide either `email` or `customerId`. When using UPSERT operation, note that providing only `customerId` (without `email`) will not create a new customer if the customer doesn't exist. The `email` field must be provided to create new customers.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), and Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"Idempotency-Key","schema":{"$ref":"#/components/schemas/IdempotencyKeyHeader"},"required":true},{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkManageCustomerProfilesRequest"}}}},"responses":{"200":{"description":"Returns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the [Get task status API](../api-group-task/#api-group-task).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/product":{"get":{"summary":"Get products","operationId":"get-products","security":[{"OAuth2":["read:product:jira-service-management"]}],"description":"**Permissions required:** Jira Service Management agent.\n","tags":["Product"],"parameters":[{"name":"limit","in":"query","description":"The number of products to fetch. Defaults to 100 if not specified or value given is less than 1 or greater than 100.","required":false,"schema":{"type":"integer","default":100,"example":50}},{"name":"cursor","in":"query","description":"The starting point for the page of results to return. Use the value of `nextPageCursor` in one request to get the next page.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns paginated list of products.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedProducts"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create product","operationId":"create-product","security":[{"OAuth2":["write:product:jira-service-management"]}],"description":"**Permissions required:** Jira Service Management agent.\n","tags":["Product"],"requestBody":{"description":"The name of the product.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductRequest"}}}},"responses":{"200":{"description":"Returns the created product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/product/{productId}":{"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for product, as a UUID.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"get":{"summary":"Get product","operationId":"get-product","security":[{"OAuth2":["read:product:jira-service-management"]}],"description":"**Permissions required:** Jira Service Management agent.\n","tags":["Product"],"responses":{"200":{"description":"Returns the requested product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"put":{"summary":"Rename product","operationId":"update-product","security":[{"OAuth2":["write:product:jira-service-management"]}],"description":"**Permissions required:** Jira Service Management agent.\n","tags":["Product"],"requestBody":{"description":"The new name of the product.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductRequest"}}}},"responses":{"200":{"description":"Returns the updated product.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete product","operationId":"delete-product","security":[{"OAuth2":["delete:product:jira-service-management"]}],"tags":["Product"],"description":"Deletes a product and all entitlements associated with it. You cannot restore a detail field once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"204":{"description":"On success, returns no response."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/entitlement/details":{"get":{"summary":"Get entitlement detail fields","operationId":"get-all-entitlement-details","tags":["Entitlement"],"security":[{"OAuth2":["read:entitlement.detail-field:jira-service-management"]}],"description":"Returns all entitlement detail fields, including their configuration. You can use the [get entitlement](./#api-api-v1-entitlement-entitlementid-get)\nAPI to get details for a particular entitlement.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"200":{"description":"Returns a list of detail fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetailFieldsWithConfiguration"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}},"post":{"summary":"Create entitlement detail field","operationId":"create-entitlement-detail","tags":["Entitlement"],"security":[{"OAuth2":["write:entitlement.detail-field:jira-service-management"]}],"description":"Creates an entitlement detail field. You can create up to 50 detail fields. <br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the created detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/entitlement/details/{fieldName}":{"parameters":[{"name":"fieldName","in":"path","description":"The name of the detail field.","required":true,"schema":{"type":"string","description":"The name of the detail field. The name must be at least 2 and at most 255 characters and cannot include the special characters `? : ; . = “`.\n","example":"Region"}}],"put":{"summary":"Edit entitlement detail field","operationId":"update-field-for-entitlements","security":[{"OAuth2":["write:entitlement.detail-field:jira-service-management"]}],"tags":["Entitlement"],"description":"Renames an entitlement detail field and/or changes the available options for SELECT or MULTISELECT fields.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldRequest"}}}},"responses":{"200":{"description":"Returns the edited entitlement detail field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete entitlement detail field","operationId":"delete-entitlement-detail","tags":["Entitlement"],"security":[{"OAuth2":["delete:entitlement.detail-field:jira-service-management"]}],"description":"Deletes an entitlement detail field and all values stored for it for all entitlements. You cannot restore a detail field once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"204":{"description":"Returns no response if the entitlement detail field is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/entitlement/{entitlementId}":{"parameters":[{"name":"entitlementId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for entitlement, as a UUID.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"get":{"summary":"Get entitlement","operationId":"get-entitlement","security":[{"OAuth2":["read:entitlement:jira-service-management","read:entitlement.detail:jira-service-management"]}],"tags":["Entitlement"],"description":"Returns an entitlement, including its details. You can get entitlements for a customer using the [get customer entitlements](../api-group-customer/#api-api-v1-customer-customerid-get) API,\nand get entitlements for an organization using the [get organization entitlements](../api-group-organization/#api-api-v1-organization-organizationid-get) API.<br><br>\n**Permissions required:** Jira Service Management agent.\n","responses":{"200":{"description":"Returns the requested entitlement.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlement"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}},"delete":{"summary":"Delete entitlement","operationId":"delete-entitlement","security":[{"OAuth2":["delete:entitlement:jira-service-management"]}],"tags":["Entitlement"],"description":"Deletes the specified entitlement along with its detail fields. You cannot restore an entitlement once it has been deleted.<br><br>\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/).\n","responses":{"204":{"description":"Returns no response if the entitlement is deleted."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/entitlement/{entitlementId}/details":{"parameters":[{"name":"entitlementId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier for entitlement, as a UUID.","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"put":{"summary":"Set entitlement detail","operationId":"update-field-value-for-entitlement","security":[{"OAuth2":["write:entitlement.detail:jira-service-management"]}],"tags":["Entitlement"],"parameters":[{"name":"fieldName","in":"query","description":"The name of the entitlement detail field to set the value of.","required":true,"schema":{"type":"string","example":"Tier"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldRequest"}}}},"description":"**Permissions required:** Jira Service Management agent.\n","responses":{"200":{"description":"Returns the updated field.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDetailFieldResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalError"}}}},"/api/v1/tasks/{taskId}":{"parameters":[{"name":"taskId","in":"path","required":true,"description":"The unique identifier for task.","schema":{"type":"string","example":"3858a61a-d337-42e6-993e-e13e1c366d4f"}}],"get":{"summary":"Get task status","operationId":"get-task-status","x-experimental":true,"security":[{"OAuth2":["read:task:jira-service-management"]}],"tags":["Task"],"description":"Returns the status of a given task, including a list of any failures on completion.\n**Permissions required:** Administer Jira [global permission](https://support.atlassian.com/jira-cloud-administration/docs/manage-global-permissions/), or Customer Service Management or Jira Service Management user.\n","parameters":[{"in":"header","name":"X-ExperimentalApi","schema":{"$ref":"#/components/schemas/ExperimentalHeader"},"required":true}],"responses":{"200":{"description":"Returns the task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskStatusResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"412":{"$ref":"#/components/responses/PreconditionFailed"},"500":{"$ref":"#/components/responses/InternalError"}}}}},"servers":[{"url":"https://api.atlassian.com/jsm/csm/cloudid/{cloudId}"}],"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"\nThis is the reference for the Customer Service Management Cloud REST APIs. The REST APIs are for developers who\nwant to integrate Customer Service Management with other applications or administrators that want to automate their\nworkflows and processes.\n"},{"title":"Authentication","anchor":"authentication","body":"\n### Authentication for REST API requests\n\nIf you are integrating directly with the Customer Service Management (CSM) REST APIs it is recommended to use the\n[OAuth 2.0 authorization code grants (3LO)](https://developer.atlassian.com/cloud/jira/service-desk/oauth-2-authorization-code-grants-3lo-for-apps/) method.\n\nFor implementations with low security requirements, such as scripts and bots, it is also possible to use the\n[Basic authentication](https://developer.atlassian.com/cloud/jira/service-desk/jira-rest-api-basic-authentication/) method.\n\n### Authentication for Atlassian Forge Apps\nYou can access the API from a Forge app using product authentication. Use the `requestJira()` method of the [product fetch API](https://developer.atlassian.com/platform/forge/runtime-reference/product-fetch-api/#requestjira) to have authentication applied automatically. Forge apps must declare [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/scopes-for-oauth-2-3LO-and-forge-apps/) scopes to be authorized to access. The scopes required for each operation are listed in the documentation.\n\nThe URIs for Forge app REST API calls have this structure: `/jsm/csm/api/v1/<resource-name>`\n\nFor example, to retrieve an organization profile with id `123`, the URI would look like: `/jsm/csm/api/v1/organization/profile/123`\n\n### Authentication using OAuth 2.0\nOAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). See [OAuth 2.0 (3LO)](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) apps for details.\n\n### Authentication for Atlassian Connect apps\nSupport for Atlassian Connect apps to interact with the CSM APIs is currently unavailable.\n"},{"title":"Bulk operations","anchor":"bulk-operations","body":"\nAPIs supporting bulk operations may trigger long-running or computationally expensive tasks. In these cases, calling the API will schedule an asynchronous task and return a response containing the task ID to be used to retrieve the status of the task.\n\nThe get task API (GET `/api/v1/tasks/{taskId}`) response will contain the `status` field as well as the `failures` field, if any operations failed.\nResults are stored for up to 3 days.\n\nNote that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute in a certain order, you should start a task only after the prerequisite task(s) have finished.\n\n### Idempotency key\nThis header allows for bulk operations to be safely retried without accidentally performing the same operation.\nSubsequent requests with the same key and request body will return the same task id, or validation errors.\nReusing the idempotency key with a different request will result in an error.\n\nWhen calling bulk operation APIs, you must include the `idempotency-key` header in your requests.\nThe value of this header should be unique for each request and is provided by the client.\nWe suggest using UUIDs as the value.\n"},{"title":"Experimental methods","anchor":"experimental","body":"\nMethods marked as <span class=\"aui-lozenge aui-lozenge-subtle aui-lozenge-current\">experimental</span> may change without notice.\nTo use experimental methods, you must include the `X-ExperimentalApi: opt-in` header in your requests.\nUse of this header indicates that you are opting into the experimental preview.\nOnce a resource or method moves out of the experimental phase, then the header will no longer be required or checked.\n"},{"title":"Jira Cloud Platform REST APIs","anchor":"jira-cloud-platform","body":"Customer Service Management is built upon the Jira platform. As such, in Customer Service Management you also have access to both the Jira platform and Jira Service Management REST APIs.\n\n* [Browse the Jira platform REST APIs](/cloud/jira/platform/rest/)\n* [Browse the Jira Service Management REST APIs](/cloud/jira/service-desk/rest/)\n"},{"title":"Permissions and roles","anchor":"permissions","body":"Permissions control the level of a user's access to the Jira Customer Service Management instance, while roles are how the permissions are assigned to individual users.\n\nFor detailed information on roles and permissions, see the [Permissions overview](https://support.atlassian.com/jira-service-management-cloud/docs/overview-of-jira-cloud-permissions/)\nand [Setting up service project users](https://support.atlassian.com/jira-service-management-cloud/docs/set-up-service-desk-users-to-work-on-requests/).\n\n**Permission types**\n\n- Global - These apply to applications as a whole, not individual projects.\n- Project - Organized into permission schemes, these apply to projects.\n- Issue - Organized into security schemes, these allow the visibility of individual issues to be adjusted.\n\n**Roles**\n\n- Jira System Administrator - can perform all Jira administration functions.\n- Jira Administrator - can perform most Jira administration functions.\n- Service project Administrator (Project role - Administrators) - assigned to specific service projects and manages those service project's configurations.\n- Agent (Project role - Service Desk Team, Project role - Customer Service Team) - assigned to specific service projects and manages and responds to Requests.\n- Customer - can submit and update their Requests, and may participate in Requests raised by other Customers.\n"},{"title":"Resource summary","anchor":"resource-summary","body":"The Jira Customer Service Management REST API enables you to work with a range of objects from Customer Service Management. The main resources provided are:\n<table>\n<thead>\n<tr>\n<th>Resource</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>customer</td>\n<td>This resource represents customers within your Jira instance. It allows for the retrieval and updating of detail fields for customers.</td>\n</tr>\n<tr>\n<td>organization</td>\n<td>This resource enables you to group Customer Service Management customers together. It allows for the retrieval and updating of detail fields for organizations.</td>\n</tr>\n<tr>\n<td>product</td>\n<td>This resource allows you to represent digital entities (products) which Jira admins provide support for to customers. It allows for the retrieval and updating of products.</td>\n</tr>\n<tr>\n<td>entitlement</td>\n<td>This resource allows you to represent which products customers use, or are entitled to. It allows for the retrieval and updating of entitlements and their detail fields.</td>\n</tr>\n</tbody>\n</table>\n"},{"title":"Status codes","anchor":"status","body":"- <span class=\"aui-lozenge aui-lozenge-success\">Status 200</span> Returned if the requested content (GET) is returned or content is updated (PUT).\n- <span class=\"aui-lozenge aui-lozenge-success\">Status 201</span> Returned if new records are created (PUT).\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 400</span> Returned if the request was invalid.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 401</span> Returned if the user is not logged in. Resolve by logging the user in and reissuing the call.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 403</span> Returned if the user does not have the necessary permission to access the resource or run the method.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 404</span> Returned if the passed path parameters do not correspond to an object in the instance, for example, no Organization exists for a passed ID.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 412</span> Returned if the API is experimental but the `X-ExperimentalApi: opt-in` header was not passed, or when calling a bulk API without the `Idempotency-key` header. For more details, see [Experimental methods](#experimental) and [Bulk operations](#bulk-operations).\n"},{"title":"URL structure","anchor":"url-structure","body":"\nThe base URL is composed by a `host` and a `base path` followed by a specific endpoint path. The `host` is always https://api.atlassian.com while the `base path` is `jsm/csm/cloudid/{cloudId}`,\nwhere `{cloudId}` is the id of your cloud instance.\n\nFor example, to retrieve an organization with id `123` from an instance with cloudId `542c7f77-92c5-41bc-9527-652d767a4c36`, the URL would look like:\n`https://api.atlassian.com/jsm/csm/cloudid/542c7f77-92c5-41bc-9527-652d767a4c36/api/v1/organization/123`\n\nTo find your cloudId follow the instructions on [this](https://confluence.atlassian.com/jirakb/how-to-find-cloud-site-id-1272283178.html#:~:text=Solution,atlassian.net%2F_edge%2Ftenant_info) page\n"},{"title":"Version","anchor":"version","body":"\nThis documentation is for Version 1 of the Customer Service Management (CSM) REST API, which is the latest version.\n\n"}]}}