Get early access

Support address

Support address: 5 operations of the ChaosDesk REST API.

Retrieves the collection of SupportAddress resources.

GET/api/support_addresses

Parameters

pageintegerquery
The collection page number
itemsPerPageintegerquery
The number of items per page
emailstringquery
namestringquery
brandstringquery
brand[]string[]query
default_groupstringquery
default_group[]string[]query
forwarding_statusstringquery
forwarding_status[]string[]query
order[email]"asc" | "desc"query
order[name]"asc" | "desc"query
order[forwarding_status]"asc" | "desc"query

Responses

  • 200SupportAddress collection
  • 403Forbidden

Example request

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

Creates a SupportAddress resource.

POST/api/support_addresses

Request body application/json

emailstring (email)
namestringrequired
brandstring (iri-reference)
default_groupstring | null (iri-reference)
is_defaultboolean
default_formstring | null (iri-reference)
Applied to new tickets received at this address (Zendesk: form by address via triggers).

Responses

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

Example request

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

Retrieves a SupportAddress resource.

GET/api/support_addresses/{id}

Parameters

idstringpathrequired
SupportAddress identifier

Responses

  • 200SupportAddress resource
  • 403Forbidden
  • 404Not found

Example request

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

Updates the SupportAddress resource.

PATCH/api/support_addresses/{id}

Parameters

idstringpathrequired
SupportAddress identifier

Request body application/merge-patch+json

emailstring (email)
namestring
brandstring (iri-reference)
default_groupstring | null (iri-reference)
is_defaultboolean
default_formstring | null (iri-reference)
Applied to new tickets received at this address (Zendesk: form by address via triggers).

Responses

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

Example request

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

Removes the SupportAddress resource.

DELETE/api/support_addresses/{id}

Parameters

idstringpathrequired
SupportAddress identifier

Responses

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

Example request

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