Disable reporter report schedules

DELETE

https://api.sureshake.com/v2/reporter/report-schedules/{id}

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- reportingIntentId
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
- accountingConnectionId
  string
  required
  format: uuid
- createdByUserId
  string
  or null
  required
- name
  string
  required
  minLength: 1
- cadence
  monthly
  or
  quarterly
  or
  annual
  required
- runDayOffset
  integer
  required
  maximum: 60 · minimum: 0
- timezone
  string
  required
  maxLength: 64 · minLength: 1 · pattern: ^[A-Za-z_]+(?:\/[A-Za-z0-9_+-]+)*$
- enabled
  boolean
  required
- nextPeriodStart
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- nextPeriodEnd
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- nextRunAt
  string
  required
  format: date-time
- lastOccurrenceAt
  string
  or null
  required
  format: date-time
- distribution
  object
  required
  viewerGroupIds
  optional
  array of
  string
  format: uuid · default: []
  emails
  optional
  array of
  string
  format: email · default: []
  permission
  optional
  read
  or
  comment
  or
  suggest
  default: "read"
  message
  optional
  string
  maxLength: 1000
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Disable reporter report schedules

curl --request DELETE \
  --url 'https://api.sureshake.com/v2/reporter/report-schedules/<id>'

const url = 'https://api.sureshake.com/v2/reporter/report-schedules/<id>';
const options = {method: 'DELETE'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "reportingIntentId": "string",
    "accountingConnectionId": "15a34c5a-2153-4717-b80d-7b1b9ec1ead9",
    "createdByUserId": "string",
    "name": "string",
    "cadence": "monthly",
    "runDayOffset": 60,
    "timezone": "string",
    "enabled": true,
    "nextPeriodStart": "string",
    "nextPeriodEnd": "string",
    "nextRunAt": "2019-08-24T14:15:22Z",
    "lastOccurrenceAt": "2019-08-24T14:15:22Z",
    "distribution": {
      "viewerGroupIds": [],
      "emails": [],
      "permission": "read",
      "message": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}