Add

post

https://us-central1-readysandbox.cloudfunctions.net/achievements-add

Adds a new achievement

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Represents achievement data from the backend.

string

Achievement document id. To trigger an achievement the id is needed.

appIds

array of strings

required

List of application ids where this achievement is used.

appIds*

requestName

string

Achievement request name. This value can be used to query or trigger achievements.

name

string

Achievement name. This value can be null or empty.

description

string

Achievement description. This value can be null or empty.

setBy

string

enum

Defines who can set the achievement as completed: - client - the client and the server can set the achievement as completed. - server - only the server can set the achievement as completed.

Allowed:

isClaimable

boolean

Should the achievement be claim manually to receive the rewards.

valueToReach

int32

Defaults to 1

Value which should be reached to complete the achievement. Default is 1.

completedAchievementsToUnlock

array of strings

Achievement ids which should be completed before this achievement can be triggered.

completedAchievementsToUnlock

repeatable

boolean

Defaults to false

Can this achievement be applied multiple times to the same user account. Default is false.

repeatNoMoreOftenThanCron

string

If provided, the trigger for this achievement will work no more often than the specified cron string. Use https://crontab.guru/ to create cron settings. For example, if the value is 0 0 1 * *, the achievement can be triggered only once a day.

startTime

int64

Start time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

endTime

int64

End time of the achievement in milliseconds since midnight, January 1, 1970 UTC.

resetTimeLimitEvery

string

Define cron value when the achievement should reset. This parameter is used to update the startTime and endTime values. Use https://crontab.guru/ to create cron settings.

rewards

array of objects

Achievement rewards ids and quantity rewards to add to users when the achievement is triggered.

rewards

requiredToComplete

object

Requirements to complete the achievement. When the achievement is triggered, the requirements are checked.

iconName

string

Icon name of the achievement.

resetIntervalDays

number | null

1 to 3650

Defaults to null

The number of days after which the achievement will reset. This field is relevant only if the achievement is repeatable. Default is null. Use it for daily, weekly, or monthly achievements. The value should be greater than 0. Every 0:00 UTC the user-achievements with this field will reset.

properties

array of objects

List of properties for the achievement.

properties

200Achievement successfully added

401Unauthenticated error 401 indicating the user is not authenticated.