This resource represents the contract to create/update/delete alert notification contacts in Jira Service Management.
Returns the list of the contacts of a user.
read:ops-config:jira-service-managementinteger
integer
Returned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts' \
--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
{
"values": [
{
"id": "299003c3-8221-4a9f-b63d-2370c4caaaaa",
"method": "email",
"to": "test@example.com",
"status": {
"enabled": true
},
"applyOrder": 0
},
{
"id": "735a619b-e420-4d46-ab5c-45523011aaaa",
"method": "sms",
"to": "90-555-555-5555",
"status": {
"enabled": true
},
"applyOrder": 1
}
],
"links": {
"next": "url?offset=2&size=1",
"last": "url?offset=2&size=1"
}
}Creates a new contact for a user.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"method": "email",
"to": "test@atlassian.com"
}'1
2
3
4
5
6
{
"message": "Created",
"data": {
"id": "35c958bb-ecc3-4cfa-8976-3830daa6231e"
}
}Activates a contact of a user.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts/{id}/activate' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"message": "Activated",
"data": {
"id": "35c958bb-ecc3-4cfa-8976-3830daa6231e"
}
}Deactivates a contact of a user.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts/{id}/deactivate' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
{
"message": "Deactivated",
"data": {
"id": "35c958bb-ecc3-4cfa-8976-3830daa6231e"
}
}Returns the details of a contact.
read:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"id": "35c958bb-ecc3-4cfa-8976-3830daa6231e",
"method": "email",
"to": "test@atlassian.com",
"status": {
"enabled": true
}
}Delete a contact of a user.
read:ops-config:jira-service-managementdelete:ops-config:jira-service-managementstring
RequiredReturned if the request is successful.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts/{id}' \
--user 'email@example.com:<api_token>'Update the details of a contact of a user. This method can be applied only to email contacts.
read:ops-config:jira-service-managementwrite:ops-config:jira-service-managementstring
Requiredstring
RequiredReturned if the request is successful.
1
2
3
4
5
6
7
8
curl --request PATCH \
--url 'https://api.atlassian.com/jsm/ops/api/{cloudId}/v1/users/contacts/{id}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"to": "90-5555559999"
}'1
2
3
4
5
6
{
"message": "Updated",
"data": {
"id": "06ba9237-d45d-40f3-a340-4a89acbdb61a"
}
}Rate this page: