Theme

Gigs

Create a Gig

POST https://cirro.io/api/v2/gigs

Parameters

ParameterTypeNote
titlerequiredstring
descriptionrequiredstring
urlrequiredstring
start_atrequirednumberUNIX timestamp
end_atrequirednumberUNIX timestamp
invitation_moderequiredenumDefault: manual. Available options: auto, manual
filter_queryrequiredobject (See below)
sort_queryobject (See below)Default: {}
archive_atnumberUNIX timestamp
total_seatsnumber
seats_minnumberDefault: 1
seats_maxnumberDefault: 1
invitation_multipliernumberDefault: 10
invitation_frequencynumberDefault: 5
notification_payloadobjectDefault: {}
invitation_notification_topicstring OR numbereither the name or the id of the topic
tasksarray OF tasks (See below)List of gig tasks
epam_optionsobject (See below)Default: {}

Tasks Parameters

ParameterTypeNote
titlerequiredstringTitle of the gig task
base_pricerequirednumberReward 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

ParameterTypeNote
extra_milebooleanDefault: 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)
Previous
Get one