Gigs
Create a Gig
POST
https://cirro.io/api/v2/gigsParameters
| Parameter | Type | Note | |
|---|---|---|---|
title | required | string | |
description | required | string | |
url | required | string | |
start_at | required | number | UNIX timestamp |
end_at | required | number | UNIX timestamp |
invitation_mode | required | enum | Default: manual. Available options: auto, manual |
filter_query | required | object (See below) | |
sort_query | object (See below) | Default: {} | |
archive_at | number | UNIX timestamp | |
total_seats | number | ||
seats_min | number | Default: 1 | |
seats_max | number | Default: 1 | |
invitation_multiplier | number | Default: 10 | |
invitation_frequency | number | Default: 5 | |
notification_payload | object | Default: {} | |
invitation_notification_topic | string OR number | either the name or the id of the topic | |
tasks | array OF tasks (See below) | List of gig tasks | |
epam_options | object (See below) | Default: {} |
Tasks Parameters
| Parameter | Type | Note | |
|---|---|---|---|
title | required | string | Title of the gig task |
base_price | required | number | Reward the worker will get after completing the task (in cents, e.g. 100 = 1€) |
Filter Query Parameters
A MongoDB-style query object (MQL) used to find matching Workers. Dot notation is supported for nested fields (e.g. skills.id).
Supported operators: $in, $nin, $or, $and, $exists, $not, $eq, $ne, $gt, etc.
See the MongoDB query operator docs for usage details.
Sort Query Parameters
A MongoDB-style sort object. Keys are field names, values are 1 (ascending) or -1 (descending). Dot notation is supported for nested fields.
See the MongoDB sort docs for usage details.
Epam Options Parameters
| Parameter | Type | Note | |
|---|---|---|---|
extra_mile | boolean | Default: false |
Description
Returns the Gig object if creation succeeded. Returns an error if creation failed.
Please see our guide on Gig creation to learn more about the parameters and their usage in different scenarios.
Example
1client = CirroIOV2::Client.new(...)
2client.Gig.create(
3 title: "My Gig",
4 description: "My Gig Description",
5 url: "https://www.example.com",
6 start_at: 1621965600,
7 end_at: 1621969200,
8 total_seats: 10,
9 invitation_mode: "auto",
10 filter_query: {
11 "status": "active",
12 "segment": "my_favorite_testers"
13 },
14 tasks: [
15 { "title": "Ah, Wilderness!", "base_price": 300 }
16 ]
17)