Greenlight links
Decline through a link
Decline through a link. POST /production-links/{token}/decline in the Raylight API.
POST
/production-links/{token}/declinePublic. No API key needed.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
tokenrequired | path | string | The signed token from the link. |
Request body
application/json
| Field | Type | Description |
|---|---|---|
reason | string |
Responses
200Declined.
400The reason is too long.
403The link was sent to someone who can no longer greenlight in this workspace, or to a webhook endpoint that was deleted (code
revoked).404Not a valid link (code
not_found).409The pitch moved on since the link was minted, or was already answered (code
stale).410The link expired (code
expired). Reading it still works and says state: expired.429Rate limited (30 a minute per address), or the workspace reached a monthly cap (code
cap).503Greenlight links are not switched on for this server (code
disabled).200 response body
| Field | Type | Description |
|---|---|---|
linkrequired | object | |
link.productionIdrequired | uuid | |
link.workspaceNamerequired | string | |
link.stagerequired | enum | One of: queued, writing_pitch, pitch_ready, greenlit, making, exporting, delivered, skipped, declined, cancelled, failed |
link.staterequired | enum | One of: open, stale, expired |
link.pitchVersionrequired | integer | |
link.currentPitchVersionrequired | integer | |
link.intentrequired | string | |
link.originrequired | object | null | |
link.origin.providerrequired | string | |
link.origin.labelrequired | string | |
link.origin.url | url | null | Default null |
link.origin.ref | string | null | Default null |
link.origin.requestedBy | string | null | Default null |
link.formatrequired | object | |
link.format.template | enum | One of: changelog, launch, feature, digest, customDefault changelog |
link.format.durationMs | integer | Default 10000 |
link.format.aspect | enum | One of: 16:9, 4:3, 3:2, 21:9, 1:1, 9:16, 3:4, 2:3, 4:5Default 16:9 |
link.format.sound | object | |
link.format.sound.voiceover | boolean | Default true |
link.format.sound.music | boolean | Default true |
link.format.sound.sfx | boolean | Default true |
link.pitchrequired | object | null | |
link.pitch.versionrequired | integer | |
link.pitch.verdict | enum | One of: video, skipDefault video |
link.pitch.verdictReason | string | null | Default null |
link.pitch.titlerequired | string | |
link.pitch.summaryrequired | string | |
link.pitch.shotsrequired | object[] | |
link.pitch.shots[].indexrequired | integer | |
link.pitch.shots[].titlerequired | string | |
link.pitch.shots[].durationMsrequired | integer | |
link.pitch.shots[].beat | string | null | Default null |
link.pitch.shots[].visualrequired | string | |
link.pitch.shots[].text | string | null | Default null |
link.pitch.shots[].voiceover | string | null | Default null |
link.pitch.shots[].mediaIds | string[] | |
link.pitch.shots[].codePaths | string[] | |
link.pitch.music | string | null | Default null |
link.pitch.estimatedCreditsrequired | integer | |
link.pitch.createdAtrequired | datetime | |
link.pitchMarkdownrequired | string | null | |
link.deliveryrequired | object | null | |
link.delivery.shareUrlrequired | url | |
link.delivery.projectIdrequired | uuid | |
link.delivery.editUrlrequired | url | |
link.delivery.exportIdrequired | uuid | |
link.delivery.deliveredAtrequired | datetime | |
link.pageUrlrequired | url | |
link.revisionsLeftrequired | integer | |
link.expiresAtrequired | datetime | |
link.channel | enum | One of: email, webhook |
Example
curl -X POST https://api.raylight.app/production-links/$TOKEN/decline \ -H "Content-Type: application/json" \ -d '{ "reason": "Already covered in the launch video." }'