Skip to main content

Create an Opportunity

ENDPOINT
POST https://api.codecoogs.com/v1/opportunities
REQUEST BODY
{
    "title": "Intern",
    "description": "Gain hands-on experience by working under a director.",
    "link_url": "https://forms.gle/DZ5kgJWWuPsxHFBs8",
    "category": "Club Role",
    "icon_url": "/assets/opportunities/intern.svg",
    "term": "Spring 2026",
    "display_order": 1,
    "website_viewable": true
}

URL Parameters​

No parameters.

Body Parameters​

title Required

The opportunity's title.

link_url Conditional

The external URL applicants use to apply. Exactly one of link_url or linked_form_id must be given — supplying both, or neither, is rejected.

linked_form_id Conditional

A UUID referencing an internal form to route applicants to, instead of an external link_url.

description string Optional

The opportunity's description.

category string Optional

The card type. Must be one of Internship, Club Role, Project, Sponsor, Job, or Other — any other value is rejected by a database constraint.

icon_url string Optional

A URL to the icon shown alongside the opportunity.

term string Optional

The application window as shown on the website card.

opens_on string Optional

The date applications open.

closes_on string Optional

The date applications close.

expires_at string Optional

Internal auto-hide timestamp.

display_order integer Optional

Controls the order opportunities are returned in.

website_viewable boolean Optional

Whether the opportunity may be shown on the public website. Omit it to fall back to the column default of false.

is_active boolean Optional

Whether the opportunity is live. Omit it to fall back to the column default of true.

Returns​

Returns a success status after successful opportunity creation. This call returns a success status and an error message if title is missing, or if link_url and linked_form_id are not exactly one-of, or if something else goes wrong.