Update reporting settings

PUT

https://api.sureshake.com/v2/entities/{id}/settings

Path parameters

id
string
required
format: uuid

Request body JSON

periodType
optional
weekly
or
monthly
or
quarterly
or
yearly
defaultPeriodLength
optional
integer
minimum: 0
autoCreatePeriods
optional
boolean
or null
periodNamingTemplate
optional
string
templateId
optional
string
or null
format: uuid
periodsInAdvance
optional
integer
or null
reminderDays
optional
integer
or null

Returns

200

Default Response

JSON

entityId
string
required
format: uuid
updatedAt
string
required
format: date-time
templateId
optional
string
or null
format: uuid
autoCreatePeriods
optional
boolean
or null
periodsInAdvance
optional
integer
or null
reminderDays
optional
integer
or null

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
}

429

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
}

503

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
}

curl --request PUT \ --url 'https://api.sureshake.com/v2/entities/<id>/settings' \ --header 'Content-Type: application/json' \ --data ' { "periodType": "weekly", "defaultPeriodLength": 0, "autoCreatePeriods": true, "periodNamingTemplate": "string", "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d", "periodsInAdvance": 0, "reminderDays": 0 } '

{ "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d", "autoCreatePeriods": true, "periodsInAdvance": 0, "reminderDays": 0, "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "updatedAt": "2019-08-24T14:15:22Z" }