Create quest
Path parameters
subdomainstringRequired
Header parameters
x-api-keystringRequired
Body
categoryIdstring · uuidRequired
namestring · max: 100Required
publishedbooleanRequired
recurrencestring · enumRequiredPossible values:
conditionOperatorstring · enumRequiredPossible values:
retryAfterone of | nullableOptionalDefault:
0
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
number · enumOptionalPossible values:
positionnumber · max: 5000Optional
claimLimitnumber · max: 2147483647OptionalDefault:
0
sprintIdstring · uuidOptional
isAutomaticWhenEmptybooleanOptionalDefault:
true
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
409
409
application/json
429
429
application/json
500
500
application/json
post
POST /public/communities/{subdomain}/quests HTTP/1.1
Host: api-v2.zealy.io
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 846
{
"categoryId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"published": true,
"recurrence": "daily",
"conditionOperator": "AND",
"retryAfter": 0,
"description": {
"type": "text",
"text": "text",
"attrs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"marks": [
{
"type": "text",
"attrs": {
"href": "text",
"target": "_blank",
"class": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
],
"content": null,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"conditions": [
{
"type": "quest",
"operator": "isCompleted",
"value": "123e4567-e89b-12d3-a456-426614174000"
}
],
"position": 1,
"claimLimit": 0,
"sprintId": "123e4567-e89b-12d3-a456-426614174000",
"tasks": [
{
"type": "partnership",
"settings": {
"subdomain": "text"
}
}
],
"rewards": [
{
"type": "xp",
"value": 1
},
{
"method": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "fcfs",
"max": 1,
"count": 1
}
}
],
"isAutomaticWhenEmpty": true
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"recurrence": "daily",
"description": {},
"retryAfter": 1,
"archived": true,
"published": true,
"communityId": "123e4567-e89b-12d3-a456-426614174000",
"categoryId": "123e4567-e89b-12d3-a456-426614174000",
"conditionOperator": "AND",
"conditions": [
{
"type": "quest",
"operator": "isCompleted",
"value": "123e4567-e89b-12d3-a456-426614174000"
}
],
"rewards": [
{
"type": "xp",
"value": 1
}
],
"tasks": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "partnership",
"settings": {
"subdomain": "text"
}
}
],
"claimLimit": 1,
"isAutomaticWhenEmpty": true
}
Last updated
Was this helpful?