Create a member

Add a new member to a loyalty program.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Individual_id does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "individual_id",
            "error": "wrong_value",
            "error_description": "Individual not found for unique key test."
        }
    ]
}

Malformatted value (400)

Generic error for all fields and custom fields values types

{
    "status": 400,
    "errors": [
        {
            "error_key": "card_code",
            "error": "wrong_type",
            "error_description": "This value should be of type string."
        }
    ]
}
{
    "status": 400,
    "errors": [
        {
            "error_key": "custom_fields[0].value",
            "error": "wrong_type",
            "error_description": "This value should be of type string."
        }
    ]
}

program is not running/does not exist (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "program_id",
            "error": "wrong_status",
            "error_description": "Program must be in running state."
        }
    ]
}

program_joined_at before program start_date (400)

{
    "statusCode": "Bad Request",
    "message": "Subscription request could not be done because of validation error(s)",
    "errors": [
        "loyalty program could not be found (program id: 2, status join date: 1588-01-01T00:00)"
    ]
}

Cardcode not specified on non-autogenerated program (400)

{
    "statusCode": "Bad Request",
    "message": "Subscription request could not be done because of validation error(s)",
    "errors": [
        "status must have a card code if the program doesn't have the card code auto generation option"
    ]
}

tier from forced_tier_name does not exist (400)

{
    "statusCode": "Bad Request",
    "message": "Subscription request could not be done because of validation error(s)",
    "errors": [
        "status program must have at least one active point based tier at tier join date"
    ]
}

Expiration before join_date (400)

{
    "statusCode": "Bad Request",
    "message": "Subscription request could not be done because of validation error(s)",
    "errors": [
        "status expiration date must not be before the program join date"
    ]
}
Body Params

Add a member on a loyalty program.

integer
required
string

The unique_key of your universe: email, cellphone or custom.

string
string
^\d\d\d\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (00|[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$

The expiration date of subscription.

date

the birthday date for card code.

string
^\d\d\d\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (00|[0-9]|1[0-9]|2[0-3]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$

the subscription external date.

string

force the setting of member tier from given tier name (you can also use vip tier name)

custom_fields
array of objects
custom_fields
Responses

401

Authentication failed.

403

Forbidden.

409

Failed to generate a card code.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json