These APIs provide a comprehensive suite for managing the Stakeholder lifecycle and incident assignments within Jira Service Management. They enable incident responders to programmatically create, search, and update stakeholder profiles, while supporting bulk operations and intelligent retrieval based on incident similarity or resource indicators. For understanding Authentication with REST APIs, refer here.
Get a list of stakeholders.
read:stakeholder-comms.stakeholder:jira-service-managementstring
string
string
string
string
boolean
integer
string
integer
string
Returned if the request is successful.
Response containing a list of stakeholders.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/list' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"connection": {
"nodes": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{}
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 49
},
"error": "<string>"
}Create a new stakeholder in Status page.
write:stakeholder-comms.stakeholder:jira-service-managementobject
Requiredstring
Returned if the stakeholder is successfully created.
Response containing a single stakeholder.
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
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholder": {
"aaid": "<string>",
"stakeholderType": "EXTERNAL",
"skipConfirmation": true,
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>",
"addedFrom": "STATUSPAGE",
"emailId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderGroupId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
},
"joiningGroupId": "<string>"
}'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
{
"stakeholder": {
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
},
"error": "<string>"
}Update a stakeholder in stakeholder communications.
write:stakeholder-comms.stakeholder:jira-service-managementobject
RequiredReturned if the stakeholder is successfully updated.
Response containing a single stakeholder.
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
curl --request PUT \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/update' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"updateStakeholderInput": {
"stakeholderIdInput": {
"stakeholderId": "<string>",
"ari": "<string>",
"aaid": "<string>",
"emailId": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderType": "EXTERNAL"
},
"status": "ACTIVE",
"notificationPreference": {
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
}
}
}'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
{
"stakeholder": {
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
},
"error": "<string>"
}Delete a stakeholder from stakeholder communications.
delete:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the stakeholder is successfully deleted.
Response indicating that the operation was successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/{stakeholderId}/delete' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
{
"success": true,
"message": "<string>"
}Create multiple stakeholders in Stakeholder Comms.
write:stakeholder-comms.stakeholder:jira-service-managementarray<undefined>
string
Returned if the bulk operation is successfully processed.
Result of a bulk stakeholder create operation.
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
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/bulk' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholders": [
{
"aaid": "<string>",
"stakeholderType": "EXTERNAL",
"skipConfirmation": true,
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>",
"addedFrom": "STATUSPAGE",
"emailId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderGroupId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
}
],
"joiningGroupId": "<string>"
}'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
{
"success": true,
"message": "<string>",
"totalCount": 2154,
"successCount": 2154,
"failureCount": 2154,
"successfulStakeholders": [
{
"stakeholder": {
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
},
"assignment": {
"id": "<string>",
"ari": "<string>",
"assignmentType": "INCIDENT",
"addedFrom": "STATUSPAGE",
"externalAssignmentId": "<string>",
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"message": "<string>",
"error": "<string>"
}
],
"errors": [
{
"index": 2154,
"error": "<string>"
}
]
}Delete multiple stakeholders from the list.
delete:stakeholder-comms.stakeholder:jira-service-managementarray<string>
Returned if the bulk delete operation is successfully processed.
Result of a bulk stakeholder delete operation.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/bulk_delete' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholderIds": [
"<string>"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"success": true,
"message": "<string>",
"totalCount": 2154,
"successCount": 2154,
"failureCount": 2154,
"successfulIds": [
"<string>"
],
"errors": [
{
"stakeholderId": "<string>",
"error": "<string>"
}
]
}Resend an invitation to a stakeholder for stakeholder communication.
write:stakeholder-comms.stakeholder:jira-service-managementobject
RequiredReturned if the invitation is successfully resent.
Response indicating that the operation was successful.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/resend_invite' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"resendInviteInput": {
"emailId": "<string>",
"aaid": "<string>"
}
}'1
2
3
4
{
"success": true,
"message": "<string>"
}Get a stakeholder by various identifiers such as stakeholder ID, email, or account ID.
read:stakeholder-comms.stakeholder:jira-service-managementstring
string
string
string
string
string
string
Returned if the request is successful.
Response containing a single stakeholder.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/get' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholder": {
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
},
"error": "<string>"
}Get stakeholders by a list of Atlassian Resource Identifiers (ARIs).
read:stakeholder-comms.stakeholder:jira-service-managementarray<string>
RequiredReturned if the request is successful.
Response containing a list of stakeholders identified by Atlassian Resource Identifiers (ARIs).
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/by_ari?stakeholderAris={stakeholderAris}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"error": "<string>"
}Get stakeholders by assignment. Deprecated, use /stakeholders/by_assignment/v2 instead.
read:stakeholder-comms.stakeholder:jira-service-managementstring
string
string
string
integer
string
Returned if the request is successful.
Response containing a list of stakeholders identified by Atlassian Resource Identifiers (ARIs).
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/by_assignment' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"error": "<string>"
}Get a paginated list of stakholders by assignment.
read:stakeholder-comms.stakeholder:jira-service-managementstring
string
string
string
integer
string
integer
string
Returned if the request is successful.
Response containing paginated list of stakeholders.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/by_assignment/v2' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>",
"hasPreviousPage": true,
"startCursor": "<string>"
},
"totalCount": 29,
"error": "<string>"
}Get a detailed list of stakeholders including those from groups
read:stakeholder-comms.stakeholder:jira-service-managementarray<string>
array<string>
string
Returned if the request is successful.
Response containing paginated list of stakeholders.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/flattened_list' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>",
"hasPreviousPage": true,
"startCursor": "<string>"
},
"totalCount": 29,
"error": "<string>"
}Get stakeholders from incidents similar to the specified incident.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Response containing a list of stakeholders identified by Atlassian Resource Identifiers (ARIs).
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/from_similar_incidents/{incidentKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"error": "<string>"
}Remove a stakeholder assignment in Stakeholder Comms.
delete:stakeholder-comms.stakeholder:jira-service-managementobject
Requiredobject
RequiredReturned if the assignment is successfully removed.
Response indicating that the operation was successful.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholders/assignments/remove' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholderIdInput": {
"stakeholderId": "<string>",
"ari": "<string>",
"aaid": "<string>",
"emailId": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderType": "EXTERNAL"
},
"assignmentIdInput": {
"assignmentId": "<string>",
"ari": "<string>",
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>"
}
}'1
2
3
4
{
"success": true,
"message": "<string>"
}Create a new stakeholder group in Stakeholder communications.
write:stakeholder-comms.stakeholder:jira-service-managementobject
Requiredarray<StakeholderCommsCreateStakeholderInput>
Returned if the stakeholder group is successfully created.
Response containing a newly created stakeholder group with its initial members.
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
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholderGroupInput": {
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"stakeholders": [
{
"stakeholder": {
"aaid": "<string>",
"stakeholderType": "EXTERNAL",
"skipConfirmation": true,
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>",
"addedFrom": "STATUSPAGE",
"emailId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderGroupId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
},
"joiningGroupId": "<string>"
}
]
}'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
{
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
],
"ownerName": "<string>",
"ownerAvatar": "<string>",
"error": "<string>"
}Get a stakeholder group by its ID for stakeholder communications.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Response containing a single stakeholder group (GET/UPDATE).
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"error": "<string>"
}Update a stakeholder group for stakeholder communications.
write:stakeholder-comms.stakeholder:jira-service-managementstring
Requiredstring
string
string
string
string
string
string
array<string>
array<StakeholderCommsCreateStakeholderInput>
Returned if the stakeholder group is successfully updated.
Response containing a single stakeholder group (GET/UPDATE).
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
curl --request PUT \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
],
"stakeholders": [
{
"stakeholder": {
"aaid": "<string>",
"stakeholderType": "EXTERNAL",
"skipConfirmation": true,
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>",
"addedFrom": "STATUSPAGE",
"emailId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderGroupId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
},
"joiningGroupId": "<string>"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"error": "<string>"
}Delete a stakeholder group from stakeholder communications.
delete:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the stakeholder group is successfully deleted.
Response indicating that the operation was successful.
1
2
3
4
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}/delete' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
{
"success": true,
"message": "<string>"
}Add members to a stakeholder group in Stakeholder communications.
write:stakeholder-comms.stakeholder:jira-service-managementstring
Requiredarray<StakeholderCommsCreateStakeholderInput>
Returned if the members are successfully added to the stakeholder group.
Response containing a list of stakeholder group members.
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
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}/members' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholders": [
{
"stakeholder": {
"aaid": "<string>",
"stakeholderType": "EXTERNAL",
"skipConfirmation": true,
"assignmentType": "INCIDENT",
"externalAssignmentId": "<string>",
"addedFrom": "STATUSPAGE",
"emailId": "<string>",
"atlassianTeamId": "<string>",
"stakeholderGroupId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {
"email": {
"enabled": true
},
"sms": {
"enabled": true
},
"webhook": {
"enabled": true
}
}
},
"joiningGroupId": "<string>"
}
]
}'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
{
"connection": {
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 55
},
"error": "<string>"
}Remove members from a stakeholder group for stakeholder communications.
delete:stakeholder-comms.stakeholder:jira-service-managementstring
Requiredarray<string>
Returned if the members are successfully removed from the stakeholder group.
Response indicating that the operation was successful.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}/members/remove' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"stakeholderIds": [
"<string>"
]
}'1
2
3
4
{
"success": true,
"message": "<string>"
}Get stakeholder groups that a stakeholder belongs to.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Connection-style response for listing stakeholder groups.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/by_membership/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 55
}Get a stakeholder group with its members.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Response containing a stakeholder group with its members.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{id}/with_memberships' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"memberships": [
{
"memberId": "<string>",
"memberType": "<string>"
}
],
"error": "<string>"
}Get a paginated list of stakeholder groups with their members.
read:stakeholder-comms.stakeholder:jira-service-managementinteger
string
integer
string
Returned if the request is successful.
Connection-style response for listing stakeholder groups.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/with_memberships' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 55
}Get stakeholder groups with their stakeholder members.
read:stakeholder-comms.stakeholder:jira-service-managementinteger
string
integer
string
Returned if the request is successful.
Paginated response for stakeholder groups with stakeholders.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/with_stakeholders' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'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
{
"groups": [
{
"group": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
},
"stakeholders": [
{
"id": "<string>",
"ari": "<string>",
"aaid": "<string>",
"stakeholderGroupId": "<string>",
"atlassianTeamId": "<string>",
"type": "EXTERNAL",
"skipConfirmation": true,
"status": "ACTIVE",
"notificationPreference": {
"id": "<string>",
"emailId": "<string>",
"phoneNumber": "<string>",
"phoneCountry": "<string>",
"webhook": "<string>",
"preference": {},
"insertedAt": "<string>",
"updatedAt": "<string>"
},
"insertedAt": "<string>",
"updatedAt": "<string>",
"name": "<string>",
"avatar": "<string>",
"groups": [
{
"id": "<string>",
"name": "<string>",
"avatar": "<string>"
}
]
}
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>",
"hasPreviousPage": true,
"startCursor": "<string>"
},
"totalCount": 23,
"error": "<string>"
}Get stakeholder groups by name.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Connection-style response for listing stakeholder groups.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/by_name/{name}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 55
}Get all members for a stakeholder group.
read:stakeholder-comms.stakeholder:jira-service-managementstring
Requiredstring
integer
Returned if the request is successful.
Connection-style response for listing stakeholder groups.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/{groupId}/memberships' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"nodes": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"ownerId": "<string>",
"logoUrl": "<string>",
"status": "ACTIVE",
"insertedAt": "<string>",
"updatedAt": "<string>",
"services": [
"<string>"
]
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>"
},
"totalCount": 55
}Check if a stakeholder group name is unique and available for use.
read:stakeholder-comms.stakeholder:jira-service-managementstring
RequiredReturned if the request is successful.
Response for validation operations.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/validate/name/{name}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
{
"valid": true,
"message": "<string>",
"error": "<string>"
}Delete multiple stakeholder groups from Stakeholder communications.
delete:stakeholder-comms.stakeholder:jira-service-managementarray<string>
Returned if the stakeholder groups are successfully deleted.
Response indicating that the operation was successful.
1
2
3
4
5
6
7
8
9
10
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/stakeholder_groups/bulk_delete' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"groupIds": [
"<string>"
]
}'1
2
3
4
{
"success": true,
"message": "<string>"
}Get assignments for a stakeholder with pagination support.
read:stakeholder-comms.assignment:jira-service-managementstring
string
string
string
string
string
string
integer
string
integer
Returned if the request is successful.
Paginated response for assignments.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/assignments/by_stakeholder/v2' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"assignments": [
{
"id": "<string>",
"ari": "<string>",
"assignmentType": "INCIDENT",
"addedFrom": "STATUSPAGE",
"externalAssignmentId": "<string>",
"insertedAt": "<string>",
"updatedAt": "<string>"
}
],
"pageInfo": {
"hasNextPage": true,
"endCursor": "<string>",
"hasPreviousPage": true,
"startCursor": "<string>"
},
"totalCount": 28,
"error": "<string>"
}Rate this page: