Get early access

Auto merge rules

Auto merge rules: 5 operations of the ChaosDesk REST API.

Retrieves the collection of AutoMergeRule resources.

GET/api/auto_merge_rules

Responses

  • 200AutoMergeRule collection
  • 403Forbidden

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/auto_merge_rules" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Creates a AutoMergeRule resource.

POST/api/auto_merge_rules

Request body application/json

conditionsobject
match_onstring[]
"subject" and/or "custom_fields.<key>" (an external reference field); any match counts.
window_minutesinteger
public_commentboolean
Merge comments are public (the requester is told) or internal notes.
merge_asstring | null (iri-reference)required
The agent the merge is recorded as (Zendesk apps run as their installing admin); needs the merge permission.
titlestringrequired
descriptionstring | null
activeboolean
positioninteger

Responses

  • 201AutoMergeRule resource created
  • 400Invalid input
  • 403Forbidden
  • 422An error occurred

Example request

curl -X POST "https://yourcompany.chaosdesk.io/api/auto_merge_rules" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"merge_as":"string","title":"string"}'

Retrieves a AutoMergeRule resource.

GET/api/auto_merge_rules/{id}

Parameters

idstringpathrequired
AutoMergeRule identifier

Responses

  • 200AutoMergeRule resource
  • 403Forbidden
  • 404Not found

Example request

curl -X GET "https://yourcompany.chaosdesk.io/api/auto_merge_rules/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"

Updates the AutoMergeRule resource.

PATCH/api/auto_merge_rules/{id}

Parameters

idstringpathrequired
AutoMergeRule identifier

Request body application/merge-patch+json

conditionsobject
match_onstring[]
"subject" and/or "custom_fields.<key>" (an external reference field); any match counts.
window_minutesinteger
public_commentboolean
Merge comments are public (the requester is told) or internal notes.
merge_asstring | null (iri-reference)
The agent the merge is recorded as (Zendesk apps run as their installing admin); needs the merge permission.
titlestring
descriptionstring | null
activeboolean
positioninteger

Responses

  • 200AutoMergeRule resource updated
  • 400Invalid input
  • 403Forbidden
  • 404Not found
  • 422An error occurred

Example request

curl -X PATCH "https://yourcompany.chaosdesk.io/api/auto_merge_rules/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"conditions":"string","match_on":"string"}'

Removes the AutoMergeRule resource.

DELETE/api/auto_merge_rules/{id}

Parameters

idstringpathrequired
AutoMergeRule identifier

Responses

  • 204AutoMergeRule resource deleted
  • 403Forbidden
  • 404Not found

Example request

curl -X DELETE "https://yourcompany.chaosdesk.io/api/auto_merge_rules/{id}" \
  -H "Authorization: Bearer $CHAOSDESK_TOKEN" \
  -H "Accept: application/json"