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_GetAchievementsForContact
Achievements_GetAllAchievements
Achievements_SetAchievement
Achievements_RemoveAchievement

Achievements_GetAchievementsForContact

• HTTP Method: GET
• Endpoint: /api/v2/contacts/{contactId}/achievements

Parameters

Name	Type	Required	Description
contactId	string	✅

Return Type

ApiAchievementValue[]

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.achievements.achievementsGetAchievementsForContact('contactId');

  console.log(data);
})();

Achievements_GetAllAchievements

• HTTP Method: GET
• Endpoint: /api/v2/achievements

Parameters

Name	Type	Required	Description
offset	number	❌
count	number	❌

Return Type

PagedResultOfApiAchievementDefinition

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.achievements.achievementsGetAllAchievements({
    offset: 7,
    count: 10,
  });

  console.log(data);
})();

Achievements_SetAchievement

• HTTP Method: POST
• Endpoint: /api/v2/contacts/{contactId}/achievements/{achievementId}

Parameters

Name	Type	Required	Description
body	any	✅	The request body.
contactId	string	✅
achievementId	string	✅

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.achievements.achievementsSetAchievement('contactId', 'achievementId', input);

  console.log(data);
})();

Achievements_RemoveAchievement

• HTTP Method: DELETE
• Endpoint: /api/v2/contacts/{contactId}/achievements/{achievementId}

Parameters

Name	Type	Required	Description
contactId	string	✅
achievementId	string	✅

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.achievements.achievementsRemoveAchievement('contactId', 'achievementId');

  console.log(data);
})();

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →