This resource represents bulk operations for organizations. Use this to perform bulk operations on organizations, including their profiles and detail fields and values.
Create up to 50 organization detail-field definitions in a single async task. You can create up to 50 detail fields. Each detail field name in the request must be unique — both within the request itself (case-insensitive, trimmed) and against the names of detail fields that already exist on the organization entity. If any name is already in use, the entire request is rejected with 400 Bad Request and no fields are created. This API does not modify or replace existing definitions.
Permissions required: Administer Jira global permission.
write:organization.detail-field:jira-service-managementIdempotencyKeyHeader
RequiredThe detail-field definitions to create.
array<CreateDetailFieldRequest>
RequiredReturns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the Get task status API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details/definitions/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: c748a424-1db8-47f9-8288-713cdb0407b5' \
--header 'Content-Type: application/json' \
--data '{
"detailFields": [
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AMER",
"EMEA",
"APAC"
]
}
},
{
"name": "Account Manager",
"type": {
"name": "TEXT"
}
},
{
"name": "Organization Tier",
"type": {
"name": "SELECT",
"options": [
"Free",
"Standard",
"Premium",
"Enterprise"
]
}
},
{
"name": "Renewal Date",
"type": {
"name": "DATE"
}
},
{
"name": "Support Email",
"type": {
"name": "EMAIL"
}
},
{
"name": "Preferred Contact Channels",
"type": {
"name": "MULTISELECT",
"options": [
"Email",
"Phone",
"Slack",
"In-app"
]
}
},
{
"name": "Primary Contact Phone",
"type": {
"name": "PHONE"
}
}
]
}'1
2
3
4
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"statusUrl": "/api/v1/tasks/3858a61a-d337-42e6-993e-e13e1c366d4f"
}Bulk manage multiple organization profiles with detail fields.
Allows creating, updating or upserting up to 100 organization profiles in a single request.
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.
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 permission using the Organization management feature available in Jira Service Management product settings.
write:organization.profile:jira-service-managementIdempotencyKeyHeader
Requiredarray<BulkManageOrganizationProfileOperation>
RequiredReturns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the Get task status API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/profile/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: c748a424-1db8-47f9-8288-713cdb0407b5' \
--header 'Content-Type: application/json' \
--data '{
"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"
]
}
}
}
]
}'1
2
3
4
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"statusUrl": "/api/v1/tasks/3858a61a-d337-42e6-993e-e13e1c366d4f"
}Bulk manage multiple organizations. This allows up to 50 organizations in a single request.
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 permission using the Organization management feature available in Jira Service Management product settings.
write:organization:jira-service-managementIdempotencyKeyHeader
Requiredarray<BulkOrganizationOperationRequest>
RequiredReturns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the Get task status API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: c748a424-1db8-47f9-8288-713cdb0407b5' \
--header 'Content-Type: application/json' \
--data '{
"organizations": [
{
"operationType": "CREATE",
"payload": {
"id": "1",
"name": "Atlassian"
}
}
]
}'1
2
3
4
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"statusUrl": "/api/v1/tasks/3858a61a-d337-42e6-993e-e13e1c366d4f"
}Bulk manage organization detail field values for multiple organizations. Supports UPDATE, PATCH, and DELETE operations across multiple organizations and detail fields. A request can include up to 1000 detail-field operations total, counted across all organizations in the request.
Permissions required: Customer Service Management or Jira Service Management user.
write:organization.detail:jira-service-managementIdempotencyKeyHeader
RequiredThe bulk operations to perform on organization detail field values, defined per organization. Operations can be combined.
array<BulkOrganizationDetailFieldOperation>
RequiredReturns a task identifier and statusUrl that can be used to retrieve information about the results of the task via the Get task status API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details/bulk' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Idempotency-Key: c748a424-1db8-47f9-8288-713cdb0407b5' \
--header 'Content-Type: application/json' \
--data '{
"organizations": [
{
"id": "1",
"operations": [
{
"operationType": "UPDATE",
"payload": {
"name": "Region",
"values": [
"Asia"
]
}
}
]
}
]
}'1
2
3
4
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"statusUrl": "/api/v1/tasks/3858a61a-d337-42e6-993e-e13e1c366d4f"
}Rate this page: