SUsuprsend

Update Event

Changed on

Update event description and its linked schema.

patch/v1/{workspace}/event/{url_encoded_event_name}/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

url_encoded_event_namestring required

URL encoded event name

Request body

descriptionstring

Description of the event. Can be used to describe which action this event is linked to.

Example request

{
  "description": "Triggered whenever a new user successfully signs up on the platform",
  "payload_schema": {
    "schema": "user_signup_v1"
  }
}

Response

Updated event details

object required

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      removed the success response with the status

    • info

      added the success response with the status