AchievementsService
A list of all methods in the AchievementsService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| achievements_get_achievements_for_contact | |
| achievements_get_all_achievements | |
| achievements_set_achievement | |
| achievements_remove_achievement |
achievements_get_achievements_for_contact
- HTTP Method:
GET - Endpoint:
/api/v2/contacts/{contactId}/achievements
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| contact_id | str | ✅ |
Return Type
List[ApiAchievementValue]
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.achievements.achievements_get_achievements_for_contact(contact_id="contactId")
print(result)
achievements_get_all_achievements
- HTTP Method:
GET - Endpoint:
/api/v2/achievements
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| offset | int | ❌ | |
| count | int | ❌ |
Return Type
PagedResultOfApiAchievementDefinition
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.achievements.achievements_get_all_achievements(
offset=8,
count=2
)
print(result)
achievements_set_achievement
- HTTP Method:
POST - Endpoint:
/api/v2/contacts/{contactId}/achievements/{achievementId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | dict | ✅ | The request body. |
| contact_id | str | ✅ | |
| achievement_id | str | ✅ |
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import dict
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = {}
result = sdk.achievements.achievements_set_achievement(
request_body=request_body,
contact_id="contactId",
achievement_id="achievementId"
)
print(result)
achievements_remove_achievement
- HTTP Method:
DELETE - Endpoint:
/api/v2/contacts/{contactId}/achievements/{achievementId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| contact_id | str | ✅ | |
| achievement_id | str | ✅ |
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.achievements.achievements_remove_achievement(
contact_id="contactId",
achievement_id="achievementId"
)
print(result)
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs