Update Destination By Id

Update a specific destination by ID

  • base_destination_update (DestinationUpdateBase): The payload containing the update data for the destination, which includes:
    • name (str): The updated name of the destination.
    • params (dict): A dictionary containing key-value pairs for parameters to be updated.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Updates a destination's name or params, and returns the updated destination.

When to use it

Use it to change where alerts go, for example a new webhook URL or recipient list, without editing the policies that use the destination.

Required parameters

  • destination_id (path): the ID of the destination.

Optional body fields: name, params.

Response

A successful call returns 200 OK with the DestinationResponse object: id, name, integration_id, integration_type, params, and timestamps.

Related: Get a destination, Test a destination, Delete a destination

Path Params
uuid
required
Body Params
length between 1 and 300
object | null
Responses

404

Not Found

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json