Harmonicft Logo
Membership IAAS

Enrollment

POSTapi/membership/enroll

Create

Enroll a new customer

Request Body (Optional)

PartnerMemberId
Required
string

The member's id in the partner's system

Email
Required
string

The member's email

Format: "email"

Phonestring

The member's phone

FirstName
Required
string

The member's first name

LastNamestring

The member's last name

State
Required
string

The member's state

Example: "CA"Maximum length: 30

PaidMemberStartDate
Required
string

The date the member's paid

Format: "date-time"

PaidThroughDate
Required
string

The last date the member's has paid

Format: "date-time"

Products
Required
array<string>

The products that the member is going to be enrolled in, provided by Harmonicft to the Partner

Example: ["LP-500"]Value in: "LP-500" | "LP-750" | "LP-1000" | ""

Header Parameters

Content-Type
Required
string

The content type

Example: "application/json"

Authorization
Required
string

The authorization header

Example: "Basic \<Base64 encoded username and password\>"
Status codeDescription
200Array of created enrollments, only showing created ones
400Bad request, including fields that are invalid
500Internal server error, including request id for support
curl -X POST "https://enroll-income-protection.harmonicft.com/api/membership/enroll" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <Base64 encoded username and password>" \
  -d '{
  "PartnerMemberId": "string",
  "Email": "user@example.com",
  "Phone": "string",
  "FirstName": "string",
  "LastName": "string",
  "State": "CA",
  "PaidMemberStartDate": "2019-08-24T14:15:22Z",
  "PaidThroughDate": "2019-08-24T14:15:22Z",
  "Products": [
    "LP-500"
  ]
}'

{
  "UserId": "string"
}

PUTapi/membership/enroll

Update

Update an enrollment with new values

Request Body (Optional)

UserId
Required
string

The ID of the enrolled user to look up

PartnerMemberIdstring

The member's id in the partner's system

Emailstring

The member's email

Format: "email"

Phonestring

The member's phone

FirstNamestring

The member's first name

LastNamestring

The member's last name

Statestring

The member's state

Example: "CA"Maximum length: 30

PaidMemberStartDatestring

The date the member's paid

Format: "date-time"

PaidThroughDatestring

The last date the member's has paid

Format: "date-time"

Productsarray<string>

The products that the member is going to be enrolled in, provided by Harmonicft to the Partner

Example: ["LP-500"]Value in: "LP-500" | "LP-750" | "LP-1000" | ""

Header Parameters

Content-Type
Required
string

The content type

Example: "application/json"

Authorization
Required
string

The authorization header

Example: "Basic \<Base64 encoded username and password\>"
Status codeDescription
200Array of created enrollments, only showing created ones
400Bad request, including fields that are invalid
500Internal server error, including request id for support
curl -X PUT "https://enroll-income-protection.harmonicft.com/api/membership/enroll" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <Base64 encoded username and password>" \
  -d '{
  "UserId": "string",
  "PartnerMemberId": "string",
  "Email": "user@example.com",
  "Phone": "string",
  "FirstName": "string",
  "LastName": "string",
  "State": "CA",
  "PaidMemberStartDate": "2019-08-24T14:15:22Z",
  "PaidThroughDate": "2019-08-24T14:15:22Z",
  "Products": [
    "LP-500"
  ]
}'

{
  "UserId": "string"
}

Previous

About the API

Next

About Webhooks