URL Expired

The URL for this request expired after 30 days.

id

string

required

[^\/\#\?]+?

PublicCreateReportScheduleDto

rrule

string

required

length ≥ 1

Bare iCalendar RRULE body. Must match the shape the in-app schedule editor renders: FREQ=WEEKLY;BYDAY=<days>;BYHOUR=<H>;BYMINUTE=<M>;BYSECOND=0 where <days> is a comma list of MO,TU,WE,TH,FR,SA,SU, <H> is 0-23, <M> is 0-59. Example: FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=9;BYMINUTE=0;BYSECOND=0. INTERVAL must be 1 (default). BYHOUR / BYMINUTE must have exactly one value each. Any other shape (FREQ=DAILY / MONTHLY / YEARLY, missing BYHOUR/BYMINUTE, multiple hours, INTERVAL>1) will break the schedule editor when the schedule is later opened. Do NOT include DTSTART;... — pair with the timezone field below and the server builds the iCal block. When timezone is omitted, BYHOUR / BYMINUTE are interpreted in UTC.

recipients

array of strings

required

length between 1 and 100

Email addresses to send the report to. Every address must belong to an active user in the caller's organization.

recipients*

string

ADD string

active

boolean

Whether the schedule is active. Defaults to true.

truefalse

timezone

string

length ≥ 1

IANA timezone (e.g. America/New_York, Europe/London). Determines how BYHOUR / BYMINUTE in rrule are interpreted. Omit for UTC.

``200 Schedule created

``400 Invalid request or recipient outside tenant

``401 Invalid or missing API key

``404 Report not found

``500 Internal server error

Updated about 1 month ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \

--url https://crm-public-api.app.carta.com/v1/reports/id/schedule \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '{"recipients":[]}'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200400401404``500

Updated about 1 month ago