Skip to main content
New to Corsair? See API access, authentication, and error handling.

Locations

create

locations.create Create a location; name and city are required Risk: write
Input Name and city are required. Omit hours or send hours: {} for a coming-soon location; a nonempty hours object must include all seven days. Sending both coordinates avoids depending on the geocoder; check the geocoding object in the response, whose status says whether the address was found, only roughly matched, not found, or queued.
Output

delete

locations.delete Delete a location from a project Risk: destructive · Irreversible
Input Output

get

locations.get Read one location and its optional attached information Risk: read
Input Output

list

locations.list List locations with filters, include flags and pagination Risk: read
Input
Output

replace

locations.replace Replace a location with the PUT contract; omitted markers and types reset to defaults Risk: write
Input PUT keeps the existing contract: supplied fields and callsToAction replace their attachments, omitted marker and type selections reset to project defaults, and a nonempty hours object replaces the whole week. Use PATCH when you want to preserve everything you leave out.
Output

update

locations.update Update selected location fields; omissions keep their saved values Risk: write
Input PATCH keeps everything you leave out. Send null to clear a field, hours: null to remove the schedule, a null value in fields or callsToAction to remove that attachment, and marker_id or location_type null to restore the project default. Invalid input saves no part of the update.
Output

Projects

list

projects.list List the projects the token can access Risk: read
Input: empty object Output

Special Hours

create

specialHours.create Create a special-hours rule, with an optional idempotency key Risk: write
Input Requires name, start_date, hours and applies_to; a missing end_date means the same day, and until_further_notice takes no end_date. The hours value is “closed”, “regular”, “open_24_hours”, or up to six {opens, closes} ranges. repeats_yearly needs a yearly holiday_key on a single day. The same Idempotency-Key with the same body replays the first answer; with a different body it answers 409.
Output

delete

specialHours.delete Delete a special-hours rule; locations fall back to weekly hours Risk: destructive · Irreversible
Input Output

get

specialHours.get Read one special-hours rule Risk: read
Input Output

list

specialHours.list List the holiday and special-hours rules of a project Risk: read
Input Output

update

specialHours.update Change selected fields of a special-hours rule Risk: write
Input
Output

Users

get

users.get Read the profile associated with the token Risk: read
Input: empty object Output