Returns a especific Type of Objective if it is active and

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Objectives/{type} \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "Title": "<string>",
    "Description": "<string>",
    "AmountOfPoints": 123,
    "Active": true,
    "Details": "<unknown>",
    "Id": 123,
    "Type": 0
  },
  "HasError": true
}

GET

pvt

Objectives

{type}

Returns a especific Type of Objective if it is active and

curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Objectives/{type} \
  --header 'Authorization: Basic <encoded-value>'

{
  "ErrorMessage": "<string>",
  "ErrorCode": 123,
  "Result": {
    "Title": "<string>",
    "Description": "<string>",
    "AmountOfPoints": 123,
    "Active": true,
    "Details": "<unknown>",
    "Id": 123,
    "Type": 0
  },
  "HasError": true
}

Authorizations

Authorization

string

header

required

Use API Basic Auth Keys

Path Parameters

type

string

required

Response

200 - application/json

ErrorMessage

string | null

Error message or description

ErrorCode

integer<int32> | null

Optional error code, if available

Result

object

Objectives response model

Show child attributes

Result.Title

string

Title of the Objective

Result.Description

string

Description of the Objective

Result.AmountOfPoints

number<decimal>

The amount of points the customer will receive on objective completion.

Result.Active

boolean

If true, the objective is active and can be used to give rewards to customers.

Result.Details

any

Result.Id

integer<int32>

Result.Type

enum<integer>

0 = Purchase 1 = Signup 2 = Birthday 3 = Review 4 = Referral 5 = SocialMediaFollowInstagram 6 = SocialMediaFollowFacebook 7 = Quiz 8 = Custom 9 = SocialMediaFollowLinkedin 10 = SocialMediaFollowTikTok

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9,

10

HasError

boolean

If true the request had an error.

Return all the active objectives for the client Import a customer to be rewarded by a custom objective

⌘I

API Privada

API Pública

Endpoint Examples

Returns a especific Type of Objective if it is active and

Authorizations

Path Parameters

Response