Proteside Endpoint referencePCI reports
Schedule recurring PCI reports for a store
POST
Persisted in organizations.partner_settings.report_schedule[store_id]; the report cron uses it to pick cadence and locale.
bearerAuthheader
AuthorizationBearer <token>API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.
org_id?stringPartners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.
Format
uuidIdempotency-Key?stringReplays the original response for 24 h
Length
1 <= length <= 255application/json- body
store_id*stringFormat
uuidcadence*stringValue in
"weekly""monthly"locale?stringDefault
"pt-BR"Value in
"pt-BR""en"active?booleanDefault
trueSchedule
application/json- response
store_id?stringFormat
uuidcadence?stringValue in
"weekly""monthly"locale?stringValue in
"pt-BR""en"active?booleanupdated_at?|Format
date-timeupdated_by?string|nullcurl -X POST "https://example.com/reports/pci/schedule" \ -H "Content-Type: application/json" \ -d '{ "store_id": "0c1d2e3f-1111-4222-8333-444455556666", "cadence": "monthly", "locale": "pt-BR" }'{ "store_id": "0c1d2e3f-1111-4222-8333-444455556666", "cadence": "monthly", "locale": "pt-BR", "active": true, "updated_at": "2026-09-27T10:15:00.000Z", "updated_by": "api:ps_live_AbCdEfGhIjKlMnOpQrStUvWx"}