SUsuperwall
Chart Annotations

Update Chart Annotation

Changed on

Changes the fields sent and keeps the rest. Send end_at: null to turn a range into a point. The result must still end after it starts. Requires charts:write scope.

patch/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

application_idstring required
chart_annotation_idstring required

Request body

labelstring

What happened, shown on the chart. 1-191 characters; leading and trailing whitespace is removed.

descriptionstring nullable

Optional detail, up to 2000 characters.

start_atstring date-time
end_atstring date-time nullable

A new end, after start_at. Send null to turn a range into a point. Omit to keep the current end.

Example request

{
  "label": "v4.2.0 released"
}

Response

Success

object'chart_annotation' required
idstring required
application_idstring required
labelstring required
descriptionstring nullable required
start_atstring required

The moment, or the start of the span. ISO 8601 UTC with milliseconds.

end_atstring nullable required

The end of the span, or null for a point. ISO 8601 UTC with milliseconds.

created_atstring required

ISO 8601 timestamp

updated_atstring required

ISO 8601 timestamp

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 7e65bcbd2cceRevision changes
    • info

      endpoint added