MemberCentral API

To access your association data using the MemberCentral API, contact [email protected]. Note that calls to the API may be rate limited and MemberCentral may disable API Access if calls exceed this limit.

Base URL and HTTPS Requirement

HTTPS connections must be used when accessing the MemberCentral API.

Use https://apibeta.membercentral.com for your beta site.
Use https://api.membercentral.com for your production site.

/address

GET - Returns address types
POST - Creates an address type
PUT - Updates an address type
DELETE - Deletes an address type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/address

expand

GET

/v1/address/{api_id}

expand

POST

/v1/address

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. Only the required keys need to be provided.

type - name of the address type, 20 char max (required)
description - description of the address type (optional)
useattn - enable the attn address field for this address type (optional, 1 or 0, defaults to 1)
useaddress2 - enable the address2 address field for this address type (optional, 1 or 0, defaults to 1)
useaddress3 - enable the address3 address field for this address type (optional, 1 or 0, defaults to 0)
usecounty - enable the county address field for this address type (optional, 1 or 0, defaults to 1)
enabledistrictmatching - enable district matching for this address type (optional, 1 or 0, defaults to 0)
standardizeaddress - enable address standardization for this address type (optional, 1 or 0, defaults to 0)
standardizecity - enable city standardization for this address type (optional, 1 or 0, defaults to 0)
standardizestate - enable state standardization for this address type (optional, 1 or 0, defaults to 0)
standardizepostalcode - enable postal code standardization for this address type (optional, 1 or 0, defaults to 0)
standardizecounty - enable county standardization for this address type (optional, 1 or 0, defaults to 0)

Note: Address standardization cannot be enabled if address3 is enabled for this address type.

Sample Request

POST /v1/address HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 78

{
    "type": "Office Address",
    "description": "Office Address",
    "useattn": 1
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body
500 NOT CREATED	error creating address type

Sample Response (success)

201 CREATED

{
    "data": {
        "count":1,
        "result": "Address type created.",
        "address": {
            "type": "Office Address",
            "description": "Office Address",
            "useattn": 1,
            "useaddress2": 1,
            "useaddress3": 0,
            "usecounty": 1,
            "enabledistrictmatching": 0,
            "standardizeaddress": 0,
            "standardizecity": 0,
            "standardizestate": 0,
            "standardizepostalcode": 0,
            "standardizecounty": 0,
            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/address/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create address type.",
        ...
    ]
}

PUT

/v1/address/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. You only need to provide the keys for data you wish to update.

type - name of the address type, 20 char max
description - description of the address type
useattn - enable the attn address field for this address type
useaddress2 - enable the address2 address field for this address type
useaddress3 - enable the address3 address field for this address type
usecounty - enable the county address field for this address type
enabledistrictmatching - enable district matching for this address type
standardizeaddress - enable address standardization for this address type
standardizecity - enable city standardization for this address type
standardizestate - enable state standardization for this address type
standardizepostalcode - enable postal code standardization for this address type
standardizecounty - enable county standardization for this address type
position - order position of the address type

Note: Address standardization cannot be enabled if address3 is enabled for this address type.

Sample Request

PUT /v1/address/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 79

{
    "type": "Office Address",
    "description": "Office Address",
    "position": 2
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 ADDRESS TYPE NOT FOUND	address type not found
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	unable to update address type

Sample Response (success)

200 OK

{
    "data": {
        "count":1,
        "result": "Address type updated.",
        "address": {
            "type": "Office Address",
            "description": "Office Address",
            "useattn": 1,
            "useaddress2": 1,
            "useaddress3": 0,
            "usecounty": 1,
            "enabledistrictmatching": 0,
            "standardizeaddress": 0,
            "standardizecity": 0,
            "standardizestate": 0,
            "standardizepostalcode": 0,
            "standardizecounty": 0,
            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/address/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update address type.",
        ...
    ]
}

DELETE

/v1/address/{api_id}

expand

/address/tag

GET - Returns address tag types
POST - Creates an address tag type
PUT - Updates an address tag type
DELETE - Deletes an address tag type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/address/tag

expand

GET

/v1/address/tag/{api_id}

expand

POST

/v1/address/tag

expand

PUT

/v1/address/tag/{api_id}

expand

DELETE

/v1/address/tag/{api_id}

expand

/authenticate

POST - Returns an API token from your API credentials. API tokens expire 30 minutes after they are generated.

Required Request Headers

content-type: application/json

Methods

GET

not applicable

POST

/v1/authenticate

expand

PUT

not applicable

DELETE

not applicable

/authenticate/me

GET - Returns an API token expiration date for your API Token.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/authenticate/me

expand

POST

not applicable

PUT

not applicable

DELETE

not applicable

/email

GET - Returns email types
POST - Creates an email type
PUT - Updates an email type
DELETE - Deletes an email type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/email

expand

GET

/v1/email/{api_id}

expand

POST

/v1/email

expand

PUT

/v1/email/{api_id}

expand

DELETE

/v1/email/{api_id}

expand

/email/tag

GET - Returns email tag types
POST - Creates an email tag type
PUT - Updates an email tag type
DELETE - Deletes an email tag type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/email/tag

expand

GET

/v1/email/tag/{api_id}

expand

POST

/v1/email/tag

expand

PUT

/v1/email/tag/{api_id}

expand

DELETE

/v1/email/tag/{api_id}

expand

/event

GET - Returns events

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/event

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is a structure of subkeys used to limit the events returned. Eligible subkeys are:
datefrom - defaulted to today
dateto - defaulted to 30 days from today
calendar - the calendar of the event
category - the category of the event
title - the title of the event
eventcode - the event code of the event
regtype - the registration type of the event, either Reg or RSVP
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Sample Requests

GET /v1/event HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/event HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 29

{
    "count": 5,
    "start": 10
}

GET /v1/event HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 97

{
    "count": 5,
    "start": 10,
    "search": {
        "datefrom": "6/4/2026",
        "dateto": "7/4/2026",
        "calendar": "Association Calendar and Events",
        "category": "Special Event",
        "title": "Fall Regional Conference",
        "eventcode": "ABCDEFGH",
        "regtype": "Reg"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count": 10,
        "events": [
            {
                "title": "Sample Event",
                "startdate": "2020-02-01 17:00:00",
                "enddate": "2020-02-01 18:30:00",
                "timezone": "US/Central",
                "eventcode": "ABCDEFGH",
                "status": "Active",
                "alldayevent": 0,
                "hidefromcalendar": 0,
                "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-api-uri": "/v1/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/event/{api_id}

expand

Sample Request

GET /v1/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 EVENT NOT FOUND	invalid event api_id

Sample Response (success)

200 OK

{
    "data": {
        "count": 1,
        "event": {
            "eventcode": "ABCDEFGH",
            "title": "Sample Event",
            "detail": "This is a sample event. Sign up today!",
            "startdate": "2020-02-01 15:00:00",
            "enddate": "2020-02-01 17:30:00",
            "timezone": "US/Central",
            "status": "Active",
            "alldayevent": 0,
            "hidefromcalendar": 0,
            "calendar": "Association Calendar and Events",
            "locationtitle": "Conference Center",
            "location": "123 Anystreet, Anytown, TX 77777",
            "traveltitle": "",
            "travel": "",
            "contacttitle": "",
            "contact": "",
            "canceltitle": "",
            "cancel": "",
            "informationtitle": "",
            "information": "",
            "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "category": [
                "Special Events",
                "CLE",
                ...
            ],
            "featuredimages": {
                "fullsize": {
                    "height": "519",
                    "width": "600",
                    "filename": "12345.jpg",
                    "url": "https://www.yourwebsite.org/featuredimages/originals/12345.jpg"
                },
                "program_listing": {
                    "height": "185",
                    "width": "185",
                    "filename": "12345-1.jpg",
                    "url": "https://www.yourwebsite.org/featuredimages/thumbnails/12345-1.jpg"
                },
                "program_detail": {
                    "height": "380",
                    "width": "380",
                    "filename": "12345-2.jpg",
                    "url": "https://www.yourwebsite.org/featuredimages/thumbnails/12345-2.jpg"
                },
                ...
            }
        }
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 EVENT NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Event not found."
    ]
}

POST

not applicable

PUT

not applicable

DELETE

not applicable

/event/registrant

GET - Returns event registrants

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/event/{api_id}/registrant

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
registereddatefrom is a date (m/d/yyyy) to limit registrations to on or after this date
registereddateto is a date (m/d/yyyy) to limit registrations to on or before this date
attended is a boolean value to limit attended or not attended registrants
rates is a pipe (|) delimited list of event rate names
roles is a pipe (|) delimited list of registrant role names
authorityname is the awarded credit authority name
credittype is the awarded credit type under the credit authority
amountbilledfrom is the billed amount from
amountbilledto is the billed amount to
amountduefrom is the due amount from
amountdueto is the due amount to
group_api_id is the api_id of a group to limit registrants to members of that group
search is a structure of subkeys used to limit the members returned.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.
result is an array of subkeys that specifies what information to return for each member. Subkeys defined here will be returned in addition to the standard data described below.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid result subkeys, an ignoredfields array is returned in the response.

Response Details

Each member listed in the response will have the same data as in the GET /members endpoint along with the following data:

x-member-api-uri - the URI of the member
x-api-uri - the URI of the member's registration
registereddate - date of registration
attended - attended status of registrant
amountdue - amount due for the registrant
totalfee - amount billed for the registrant

Sample Request

GET /v1/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/registrant HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/registrant HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 146

{
    "count": 5,
    "registereddatefrom": "1/23/2020",
    "registereddateto": "1/25/2020",
    "attended": true,
    "rates": "EarlyBird|Regular Member",
    "roles": "Speaker",
    "authorityname": "Credit Authority Name",
    "credittype": "Credit Authority Type",
    "amountduefrom": "0.00",
    "amountdueto": "10.00",
    "amountbilledfrom": "10.00",
    "amountbilledto": "120.00",
    "group_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "search": {
        "primary address_city": "Austin",
        "language": "Spanish"
    },
    "result": [
        "email"
    ]
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 EVENT NOT FOUND	invalid event api_id

Sample Response (success)

200 OK

{
    "data": {
        "count":5,
        "registrants":[
            {
                "membernumber":"SAMPLE123456",
                "prefix":"Mrs.",
                "firstname":"Jane",
                "middlename":"",
                "lastname":"Doe",
                "suffix":"",
                "professionalsuffix":"",
                "company":"Law Office of Jane Doe",
                "datecreated":"August, 05 2020 09:57:31 -0700",
                "datelastupdated":"August, 09 2020 19:09:36 -0700",
                "mcaccountstatus":"Active",
                "mcaccounttype":"User",
                "mcrecordtype":"Individual",
                "email": "[email protected]",
                "x-member-api-uri":"/v1/member/SAMPLE123456",
                "x-member-photo-uri":"https://www.yourwebsite.org/memberphotos/sample123456.jpg",
                "x-api-uri":"/v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/ZZZZZZZ",
                "dateregistered":"August, 10 2020 16:31:54 -0700",
                "attended": 1,
                "amountdue": "0.00",
                "totalfee": "100.00",
            } ...
        ]
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 EVENT NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Event not found."
    ]
}

POST

not applicable

PUT

not applicable

DELETE

not applicable

/group

GET - Returns groups
POST - Creates a group
PUT - Updates a group
DELETE - Deletes a group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/group

expand

GET

/v1/group/{api_id}

expand

POST

/v1/group

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. Only the required keys need to be provided.

group - name of the group (required)
groupcode - unique group code for the group (optional)
description - description of the group (optional)
manualassignments - if manual assignments are allowed (optional, defaults to false)
badgebackgroundcolor - badge background color (optional)
badgetextcolor - badge text color (optional)
parentapi_id - the new group would be a child of the provided parent group api_id (optional)

Sample Request

POST /v1/group HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 111

{
    "group": "My Test Group A",
    "groupcode": "TestA",
    "parentapi_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body
500 NOT CREATED	error creating group

Sample Response (success)

201 CREATED

{
    "data": {
        "count":1,
        "result": "Group created.",
        "group": {
            "group": "My Test Group A"
            "groupcode": "TestA",
            "grouppath": "My Test Groups \\ My Test Group A",
            "description": "",
            "systemgroup": 0,
            "alertifpopulated": 0,
            "manualassignments": 0,
            "protected": 0,
            "membercount": 0,
            "badgebackgroundcolor": "#3b3e66",
            "badgetextcolor": "#ffffff",
            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "parentapi_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "x-parent-api-uri": "/v1/group/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
        }
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create group.",
        ...
    ]
}

PUT

/v1/group/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. You only need to provide the keys for data you wish to update.

group - name of the group
groupcode - unique group code for the group
description - description of the group
manualassignments - if manual assignments are allowed
badgebackgroundcolor - badge background color
badgetextcolor - badge text color
applybadgecolortochildren - apply this group's colors to all child groups (default FALSE)
parentapi_id - this group's new parent group api_id

Sample Request

PUT /v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 33

{
    "group": "My Test Group ABC"
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 GROUP NOT FOUND	invalid group api_id
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating group

Sample Response (success)

200 OK

{
    "data": {
        "count":1,
        "result": "Group updated.",
        "group": {
            "group": "My Test Group ABC"
            "groupcode": "TestA",
            "grouppath": "My Test Groups \\ My Test Group ABC",
            "description": "",
            "systemgroup": 0,
            "alertifpopulated": 0,
            "manualassignments": 0,
            "protected": 0,
            "membercount": 0,
            "badgebackgroundcolor": "#3b3e66",
            "badgetextcolor": "#ffffff",
            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "parentapi_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "x-parent-api-uri": "/v1/group/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
        }
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update group.",
        ...
    ]
}

DELETE

/v1/group/{api_id}

expand

/group/member

GET - Returns the group's member assignments
PUT - Manually assigns the member to the group
DELETE - Removes a member's manual assignment to the group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/group/{api_id}/member

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
datelastupdated is the start date (m/d/yyyy) or datetime in 24-hour format (m/d/yyyy HH:mm) you'd like to limit members to. The default action is to not consider the date the member was last updated. This date is US Central Time.
search is a structure of subkeys used to limit the members returned.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.
result is an array of subkeys that specifies what information to return for each member. Subkeys defined here will be returned in addition to the standard data described below.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid result subkeys, an ignoredfields array is returned in the response.

Response Details

Each member listed in the response will have the same data as in the GET /members endpoint along with the following data:

x-member-api-uri - the URI of the member
x-api-uri - the URI of the group assignment
directmanual - if the member is manually assigned to this group
directvirtual - if the member is assigned to this group via a group assignment rule
indirectmanual - if the member is manually assigned to a lower group in the group path
indirectvirtual - if the member is assigned to a lower group via a group assignment rule

Sample Request

GET /v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/member HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/member HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 146

{
    "count": 5,
    "datelastupdated": "6/1/2026 16:30",
    "search": {
        "primary address_city": "Austin",
        "language": "Spanish"
    },
    "result": [
        "email",
        "primary address_state"
    ]
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 GROUP NOT FOUND	invalid group api_id

Sample Response (success)

200 OK

{
    "data": {
        "count":10,
        "members":[
            {
                "membernumber":"SAMPLE123456",
                "prefix":"Mrs.",
                "firstname":"Jane",
                "middlename":"",
                "lastname":"Doe",
                "suffix":"",
                "professionalsuffix":"",
                "company":"Law Office of Jane Doe",
                "datecreated":"August, 05 2017 09:57:31 -0700",
                "datelastupdated":"August, 09 2017 19:09:36 -0700",
                "mcaccountstatus":"Active",
                "mcaccounttype":"User",
                "mcrecordtype":"Individual",
                "username":"JaneDoe",
                "x-member-api-uri":"/v1/member/SAMPLE123456",
                "x-member-photo-uri":"https://www.yourwebsite.org/memberphotos/sample123456.jpg",
                "x-api-uri":"/v1/member/SAMPLE123456/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "indirectmanual": 0,
                "directvirtual": 0,
                "indirectvirtual": 0,
                "directmanual": 1,
            } ...
        ]
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 GROUP NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Group not found."
    ]
}

GET

/v1/group/{api_id}/member/{membernumber}

expand

POST

not applicable

PUT

/v1/group/{api_id}/member/{membernumber}

expand

DELETE

/v1/group/{api_id}/member/{membernumber}

expand

/list

GET - Returns lists

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/list

expand

GET

/v1/list/{list_name}

expand

POST

not applicable

PUT

not applicable

DELETE

not applicable

/member

GET - Returns member records
POST - Creates a member record
PUT - Updates a member record
DELETE - Deletes a member record

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
datelastupdated is a date (m/d/yyyy) or datetime in 24-hour format (m/d/yyyy HH:mm) you'd like to limit members to. The default action is to not consider the date the member was last updated. This date is US Central Time.
search is an object of subkeys used to limit the members returned.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.
result is an array of subkeys that specifies what information to return for each member. Subkeys defined here will be returned in addition to the standard data described below.
Use the /v1/member/{membernumber} GET API reference for the list of eligible subkeys.
If your JSON object contains invalid result subkeys, an ignoredfields array is returned in the response.

Sample Requests

GET /v1/member HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/member HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 61

{
    "count": 5,
    "start": 10,
    "datelastupdated": "6/1/2026 15:30"
}

GET /v1/member HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 146

{
    "count": 5,
    "search": {
        "primary address_city": "Austin",
        "language": "Spanish"
    },
    "result": [
        "email",
        "primary address_state"
    ]
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count":10,
        "members":[
            {
                "company":"Law Office of Jane Doe",
                "datecreated":"August, 05 2017 09:57:31 -0700",
                "datelastupdated":"August, 09 2017 19:09:36 -0700",
                "firstname":"Jane",
                "lastname":"Doe",
                "membernumber":"SAMPLE123456",
                "mcaccountstatus":"Active",
                "mcaccounttype":"User",
                "mcrecordtype":"Individual",
                "middlename":"",
                "prefix":"Mrs.",
                "professionalsuffix":"",
                "suffix":"",
                "username":"JaneDoe",
                "x-api-uri":"/v1/member/SAMPLE123456",
                "x-photo-uri":"https://www.yourwebsite.org/memberphotos/sample123456.jpg"
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/member/{membernumber}

expand

POST

/v1/member

expand

PUT

/v1/member/{membernumber}

expand

Required Request Details

The request must contain a JSON object in the body with keys shown in the /v1/member/{membernumber} GET API reference.

Sample Request

PUT /v1/member/SAMPLE123456 HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 32

{
    "firstname": "NewFirstName"
}

Possible Response Codes

200 OK	success
202 NOT UPDATED	no changes to process
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating member

Sample Response (success)

200 OK

{
    "data": {
        "result": "Member updated.",
        "report": [
            "summary": [
                "1 existing member will be updated.",
                ...
            ],
            "files": [
                "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
                ...
            ],
            "rejected": [],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": [
                "LastName, NewFirstName (SAMPLE123456) - First name changed from Pat to NewFirstName",
                ...
            ]
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (no changes)

202 NOT UPDATED

{
    "data": {
        "result": "No changes to process.",
        "report": [
            "summary": [
                "1 data change was rejected and ignored.",
                ...
            ],
            "files": [
                "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
                ...
            ],
            "rejected": [
                "LastName, NewFirstName (SAMPLE123456) - website is not valid: http://mysite"
            ],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": []
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update member.",
	    ...
    ]
}

DELETE

/v1/member/{membernumber}

expand

/member/address

GET - Returns the member's addresses
PUT - Updates a member's address
DELETE - Removes a member's address

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/address

expand

Each address listed in the response will have the following data:

type - name of the address type
attn - the member's attention field for this address type, if enabled
address1 - the member's address1 field for this address type
address2 - the member's address2 field for this address type, if enabled
address3 - the member's address3 field for this address type, if enabled
city - the member's city field for this address type
stateprov - the member's stateprov field for this address type
postalcode - the member's postalcode field for this address type
country - the member's country field for this address type
county - the member's county field for this address type, if enabled
addresslastupdated - the date the member's address was last updated
addresslastvalidated - the date the member's address was last validated, if enabled
districtlastupdated - the date the member's address districting was last updated, if enabled
api_id - unique identifer of the address type
x-api-uri - the URI of the member address type

Sample Request

GET /v1/member/SAMPLE123456/address HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber

Sample Response (success)

200 OK

{
    "data": {
        "count":2,
        "address": [
            {
                "api_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-api-uri":"/v1/member/SAMPLE123456/address/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "type":"Business Address",
                "attn":"",
                "address1":"123 AnyStreet",
                "address2":"",
                "address3":"",
                "city":"Anytown",
                "stateprov":"TX",
                "postalcode":"77777",
                "country":"United States",
                "county":"",
                "addresslastupdated":"1/1/2019"
            },
            {
                "api_id":"YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "x-api-uri":"/v1/member/SAMPLE123456/address/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "type":"Home Address",
                "attn":"",
                "address1":"678 OtherStreet",
                "address2":"",
                "address3":"",
                "city":"Othertown",
                "stateprov":"TX",
                "postalcode":"77777",
                "country":"United States",
                "county":"",
                "addresslastupdated":"1/1/2019"
            }
         ]
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 MEMBER NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Member not found."
    ]
}

GET

/v1/member/{membernumber}/address/{api_id}

expand

POST

not applicable

PUT

/v1/member/{membernumber}/address/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the address parts to update.

attn - the member's attention field for this address type, if enabled
address1 - the member's address1 field for this address type
address2 - the member's address2 field for this address type, if enabled
address3 - the member's address3 field for this address type, if enabled
city - the member's city field for this address type
stateprov - the member's stateprov field for this address type
postalcode - the member's postalcode field for this address type
country - the member's country field for this address type
county - the member's county field for this address type, if enabled

Sample Request

PUT /v1/member/SAMPLE123456/address/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 96

{
    "address1": "123 AnyStreet",
    "city": "Anytown",
    "stateprov": "TX",
    "postalCode": "77777"
}

Possible Response Codes

200 OK	success
202 NOT UPDATED	no changes to process
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 ADDRESS TYPE NOT FOUND	invalid address api_id
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating address

Sample Response (success)

200 OK

{
    "data": {
        "result": "Member updated.",
        "report": [
            "summary": [
                "1 existing member will be updated.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": [
                "LastName, NewFirstName (SAMPLE123456) - Business Address City changed from Othertown to Anytown",
                ...
            ]
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (no changes)

202 NOT UPDATED

{
    "data": {
        "result": "No changes to process.",
        "report": [
            "summary": [
                "1 data change was rejected and ignored.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [
                "LastName, NewFirstName (SAMPLE123456) - Business Address Country was not provided"
            ],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": []
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update member.",
        ...
    ]
}

DELETE

/v1/member/{membernumber}/address/{api_id}

expand

/member/credit

GET - Returns the credits earned by the member

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/credit

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is a structure of subkeys used to limit the credits returned. Eligible subkeys are:
programdatefrom is a date to limit the credit awarded programs to on or after this date
programdateto is a date to limit the credit awarded programs to on or before this date
authority - credit authority
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Response Details

Each credit included in the response will have the following data.

programdate

program

programtype

authorities

type

amount

Sample Requests

GET /v1/member/SAMPLE123456/credit HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/member/SAMPLE123456/credit HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 157

{
    "count": 5,
    "start": 10,
    "search": {
        "programdatefrom": "1/1/2026",
        "programdateto": "1/31/2026",
        "authority": "Credit Authority Name"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count":5,
        "credit": [
            {
                "programdate": "2019-01-15 08:00:00",
                "program": "Sample Event",
                "programtype": "Event",
                "authorities": [
                    {
                        "authority": "Authority Name",
                        "credittypes": [
                            {
                                "type": "Ethics",
                                "amount": 2
                            }
                        ]
                    }
                ]
            }
            ...
        ]
    },
    "error":false,
    "messages":[]
}

POST

not applicable

PUT

not applicable

DELETE

not applicable

/member/email

GET - Returns the member's email addresses
PUT - Updates a member's email address
DELETE - Removes a member's email address

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/email

expand

GET

/v1/member/{membernumber}/email/{api_id}

expand

POST

not applicable

PUT

/v1/member/{membernumber}/email/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with one key, email.

email is the member's email address for this email type.

Sample Request

PUT /v1/member/SAMPLE123456/email/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 56

{
    "email": "[email protected]"
}

Possible Response Codes

200 OK	success
202 NOT UPDATED	no changes to process
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 EMAIL TYPE NOT FOUND	invalid email api_id
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating email

Sample Response (success)

200 OK

{
    "data": {
        "result": "Member updated.",
        "report": [
            "summary": [
                "1 existing member will be updated.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": [
                "LastName, NewFirstName (SAMPLE123456) - Alternate Email changed from [email protected] to [email protected]",
                ...
            ]
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (no changes)

202 NOT UPDATED

{
    "data": {
        "result": "No changes to process.",
        "report": [
            "summary": [
                "1 data change was rejected and ignored.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [
                "LastName, NewFirstName (SAMPLE123456) - Alternate Email is not valid: samplealternateemail@org"
            ],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": []
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update member.",
        ...
    ]
}

DELETE

/v1/member/{membernumber}/email/{api_id}

expand

/member/event

GET - Returns the member's event registrations
PUT - Sets the registrant's attendance and credits

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/event

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is an object of subkeys used to limit the events returned. Eligible subkeys are:
registereddatefrom is a date to limit registrations to on or after this date
registereddateto is a date to limit registrations to on or before this date
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Response Details

Each event listed in the response will have the following data:

eventcode - unique identifier of the event
title - name of the event
subtitle - sub title of the event
startdate - start date of the event
enddate - end date of the event
alldayevent - if 1, this is an all-day event and event times should be ignored.
event_api_id - api_id of the event
registrant - array of registrant data for this registration. Each item in the array will contain:
x-api-uri - the URI of the member's registration
attended - if 1, the member attended the event
notes - any registrant notes
isflagged - if 1, the registrant is flagged
dateregistered - date of registration
rate_api_id - api_id of the rate
rate - name of the rate
ratereportcode - unique identifier of the rate

Sample Requests

GET /v1/member/SAMPLE123456/event HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/member/SAMPLE123456/event HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 157

{
    "count": 5,
    "start": 10,
    "search": {
        "registereddatefrom": "1/1/2026",
        "registereddateto": "1/31/2026"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count":11,
        "event":[
            {
                "eventcode": "ABCDEFGH",
                "title": "Fall Regional Conference",
                "subtitle": "Network and Collaborate",
                "startdate": "2019-03-01 17:00:00",
                "enddate": "2019-03-01 19:00:00",
                "alldayevent": 0,
                "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "registrant": [
                    {
                        "x-api-uri": "/v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/YYYYYYY",
                        "attended": 1,
                        "notes": "",
                        "isflagged": 0,
                        "dateregistered": "2019-01-15 08:48:32",
                        "rate_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                        "rate": "Sample Rate",
                        "ratereportcode": "LMNOPQ"
                    }
                    ...
                ]
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/member/{membernumber}/event/{api_id}

expand

Response Details

If the member is registered for this event, the event in the response will have the same data as the /member/event GET call as well as registrant-specific data.
If the member is not registered for this event, the response will be a 404 Event Registration Not Found.

Sample Request

GET /v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 EVENT NOT FOUND	invalid event api_id
404 EVENT REGISTRATION NOT FOUND	member is not registered for this event

Sample Response (success)

200 OK

{
  "data": {
      "count": 1,
      "event": {
          "title": "Fall Regional Conference",
          "subtitle": "Network and Collaborate",
          "startdate": "2019-03-01 17:00:00",
          "enddate": "2019-03-01 19:00:00",
          "eventcode": "ABCDEFGH",
          "alldayevent": 0,
          "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "registrant": [
              {
                  "x-api-uri": "/v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/YYYYYYY",
                  "attended": 1,
                  "notes": "",
                  "isflagged": 0,
                  "dateregistered": "2019-01-15 08:48:32",
                  "rate_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                  "rate": "Sample Rate",
                  "ratereportcode": "LMNOPQ"
                  "amountbilled": "149.00",
                  "amountdue": "10.00",
                  "roles": [
                      {
                          "role": "Speaker",
                          "fields": {
                              "Speaker Type": "Panelist",
                              "Date Approved": "01/20/2019",
                              "Audio/Visual": "Handheld Mic|Tabletop Mic"
                              ...
                          }
                      }
                      ...
                  ],
                  "fields": {
                      "Want to be contacted": "Yes"
                      ...
                  },
                  "credit": [
                      {
                          "authorityname": "State Bar Of California",
                          "authoritycode": "CAStateBar",
                          "credittype": "General",
                          "credittypecode": "General",
                          "creditawarded": 3,
                          "idnumber": "CA123456"
                      }
                      ...
                  ]
              }
              ...
          ]
      }
    },
  "error":false,
  "messages":[]
}

Sample Response (failure)

404 EVENT REGISTRATION NOT FOUND

{
	"data": {},
	"error": true,
	"messages": [
	    "Event Registration Not Found."
	]
}

GET

/v1/member/{membernumber}/event/{api_id}/{registrant_id}

expand

Response Details

If the member is registered for this event with this registrant_id, the event in the response will have the same data as the /member/event GET call as well as registrant-specific data.
If the member is not registered for this event with this registrant_id, the response will be a 404 Event Registration Not Found.

Sample Request

GET /v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/123456 HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 EVENT NOT FOUND	invalid event api_id
404 EVENT REGISTRATION NOT FOUND	member is not registered for this event

Sample Response (success)

200 OK

{
  "data": {
      "count": 1,
      "event": {
          "title": "Fall Regional Conference",
          "subtitle": "Network and Collaborate",
          "startdate": "2019-03-01 17:00:00",
          "enddate": "2019-03-01 19:00:00",
          "eventcode": "ABCDEFGH",
          "alldayevent": 0,
          "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "registrant": [
              {
                  "x-api-uri": "/v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/YYYYYYY",
                  "attended": 1,
                  "notes": "",
                  "isflagged": 0,
                  "dateregistered": "2019-01-15 08:48:32",
                  "rate_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                  "rate": "Sample Rate",
                  "ratereportcode": "LMNOPQ"
                  "amountbilled": "149.00",
                  "amountdue": "10.00",
                  "roles": [
                      {
                          "role": "Speaker",
                          "fields": {
                              "Speaker Type": "Panelist",
                              "Date Approved": "01/20/2019",
                              "Audio/Visual": "Handheld Mic|Tabletop Mic"
                              ...
                          }
                      }
                      ...
                  ],
                  "fields": {
                      "Want to be contacted": "Yes"
                      ...
                  },
                  "credit": [
                      {
                          "authorityname": "State Bar Of California",
                          "authoritycode": "CAStateBar",
                          "credittype": "General",
                          "credittypecode": "General",
                          "creditawarded": 3,
                          "idnumber": "CA123456"
                      }
                      ...
                  ]
              }
          ]
      }
    },
  "error":false,
  "messages":[]
}

Sample Response (failure)

404 EVENT REGISTRATION NOT FOUND

{
	"data": {},
	"error": true,
	"messages": [
	    "Event Registration Not Found."
	]
}

POST

not applicable

PUT

/v1/member/{membernumber}/event/{api_id}/{registrant_id}

expand

Required Request Details

The request must contain a JSON object in the body with one or more of the following keys:

isflagged - optional; if provided, must be 1 or 0. 1 will flag the registration
attended - optional; if provided, must be 1 or 0. 1 will mark the registration as attended
credit - optional; if provided, must contain complete array of credits to be awarded to registrant. All 4 subkeys are required for each credit. Any existing credits will be removed prior to assigning credit.
authoritycode - the credit authority code
credittypecode - the credit type code
creditawarded - the numeric amount of credit awarded
idnumber - may be blank; any authority specific ID number for this registrant

Sample Request

PUT /v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/123456 HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 111

{ 
    "attended": 1,
    "isflagged": 0,
    "credit": [
        {
            "authoritycode": "xxxxx",
            "credittypecode": "xxxxx",
            "creditawarded": 1.5,
            "idnumber": "xxxxx"
        }
    ]
}

Possible Response Codes

200 UPDATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 EVENT NOT FOUND	invalid event api_id
404 EVENT REGISTRATION NOT FOUND	member is not registered for this event/td>
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating registration

Sample Response (success)

200 UPDATED

{
  "data": {
      "count": 1,
      "event": {
          "title": "Fall Regional Conference",
          "subtitle": "Network and Collaborate",
          "startdate": "2019-03-01 17:00:00",
          "enddate": "2019-03-01 19:00:00",
          "eventcode": "ABCDEFGH",
          "alldayevent": 0,
          "event_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
          "registrant": [
              {
                  "x-api-uri": "/v1/member/SAMPLE123456/event/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/YYYYYYY",
                  "attended": 1,
                  "notes": "",
                  "isflagged": 0,
                  "dateregistered": "2019-01-15 08:48:32",
                  "rate_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                  "rate": "Sample Rate",
                  "ratereportcode": "LMNOPQ"
                  "amountbilled": "149.00",
                  "amountdue": "10.00",
                  "roles": [
                      {
                          "role": "Speaker",
                          "fields": {
                              "Speaker Type": "Panelist",
                              "Date Approved": "01/20/2019",
                              "Audio/Visual": "Handheld Mic|Tabletop Mic"
                              ...
                          }
                      }
                      ...
                  ],
                  "fields": {
                      "Want to be contacted": "Yes"
                      ...
                  },
                  "credit": [
                      {
                          "authorityname": "State Bar Of California",
                          "authoritycode": "CAStateBar",
                          "credittype": "General",
                          "credittypecode": "General",
                          "creditawarded": 3,
                          "idnumber": "CA123456"
                      }
                      ...
                  ]
              }
          ]
      }
    },
  "error":false,
  "messages":[]
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update registration."
    ]
}

DELETE

not applicable

/member/event/credit

GET - Returns the member's event registration credits
PUT - Sets the member's event registration credits

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/event/{api_id}/{registrant_id}/credit

expand

POST

not applicable

PUT

/v1/member/{membernumber}/event/{api_id}/{registrant_id}/credit

expand

PUT

/v1/member/{membernumber}/event/{api_id}/{registrant_id}/credit/{authoritycode}_{typecode}

expand

DELETE

/v1/member/{membernumber}/event/{api_id}/{registrant_id}/credit

expand

DELETE

/v1/member/{membernumber}/event/{api_id}/{registrant_id}/credit/{authoritycode}_{typecode}

expand

/member/group

GET - Returns the member's group assignments
PUT - Manually assigns the member to the group
DELETE - Removes a member's manual assignment to the group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/group

expand

Response Details

Each group listed in the response will have the following data:

group - name of the group
grouppath - full path of the group
description - description of the group
groupcode - group code of the group, if defined
api_id - unique identifer of the group
x-group-api-uri - the URI of the group
x-api-uri - the URI of the group assignment
directmanual - if the member is manually assigned to this group
directvirtual - if the member is assigned to this group via a group assignment rule
indirectmanual - if the member is manually assigned to a lower group in the group path
indirectvirtual - if the member is assigned to a lower group via a group assignment rule

Sample Request

GET /v1/member/SAMPLE123456/group HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber

Sample Response (success)

200 OK

{
    "data": {
        "count":3,
        "group": [
            {
                "api_id":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-api-uri":"/v1/member/SAMPLE123456/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-group-api-uri":"/v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "grouppath":"My Test Groups \\ My Test Group A",
                "indirectmanual": 0,
                "directvirtual": 0,
                "indirectvirtual": 0,
                "directmanual": 1,
                "groupcode": "TestA",
                "description": "",
                "group": "My Test Group A"
            },
            {
                "api_id":"YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "x-api-uri":"/v1/member/SAMPLE123456/group/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "x-group-api-uri":"/v1/group/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "grouppath":"All Members and Staff",
                "indirectmanual": 1,
                "directvirtual": 0,
                "indirectvirtual": 0,
                "directmanual": 0,
                "groupcode": "membersstaff",
                "description": "Members and Staff",
                "group": "All Members and Staff"
            },
            {
                "api_id":"ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "x-api-uri":"/v1/member/SAMPLE123456/group/ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "x-group-api-uri":"/v1/group/ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "grouppath":"Spanish Speakers",
                "indirectmanual": 0,
                "directvirtual": 0,
                "indirectvirtual": 1,
                "directmanual": 0,
                "groupcode": "",
                "description": "Members selecting Spanish as their language",
                "group": "Spanish Speakers"
            }
         ]
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 MEMBER NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Member not found."
    ]
}

GET

/v1/member/{membernumber}/group/{api_id}

expand

POST

not applicable

PUT

/v1/member/{membernumber}/group/{api_id}

expand

DELETE

/v1/member/{membernumber}/group/{api_id}

expand

/member/list

GET - Returns the member's list memberships
POST - Add a member's list membership
PUT - Update a member's list membership
DELETE - Remove a member's list membership

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/list

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is a structure of subkeys used to limit the lists returned. Eligible subkeys are:
email - e-mail address of the list membership
listname - list name
name - member's name on the list
lockname - 1 or 0, if the Lock Name flag is set for this list membership
lockaddress - 1 or 0, if the Lock Address flag is set for this list membership
keepactive - 1 or 0, if the Keep Active flag is set for this list membership
membertype - member type of the list membership. Valid values are: normal, confirm, private, expired, held, unsub, referred, needs-confirm, needs-hello, needs-goodbye
subtype - subscription type of the list membership. Valid values are: mail, digest, mimedigest, index, nomail
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Response Details

Each list membership included in the response will have the same data structure as the GET /v1/member/{membernumber}/list/{listname} response.

Sample Requests

GET /v1/member/SAMPLE123456/list HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/member/SAMPLE123456/list HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 157

{
    "count": 5,
    "start": 10,
    "search": {
        "membertype": "normal",
        "subtype": "mail"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count":5,
        "list": [
            {
                "listname": "samplelist",
                "membertype": "normal",
                "subtype": "mail",
                "name": "Jane Doe, Esq",
                "email": "[email protected]",
                "lockname": 1,
                "lockaddress": 0,
                "keepactive": 0,
                "api_id": 0000000,
                "x-api-uri": "/v1/member/SAMPLE123456/list/samplelist/0000000"
            }
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/member/{membernumber}/list/{listname}

expand

Response Details

If the member has a membership for this list, the lists in the response will have the following data:

email

listname

name

lockname

lockaddress

keepactive

api_id

x-api-uri

membertype

normal: An active member who may receive mail from the list.
confirm: The person has requested to join this mailing list, but has not confirmed the subscription request by replying or clicking on a confirmation message. Once the member has confirmed membership, the person's status will change to normal.
private: Awaiting admin approval.
expired: Subscription has expired.
held: An undeliverable member. ListManager failed to deliver mail to this address the number of times specified for the list . A user may become "unheld" by replying to a held notification
unsub: The member has opted out of the list. The member will not receive email, but is retained in the database for statistical reasons or in case the member decides to resubscribe.
referred: Referred by a friend and awaiting confirmation.
needs-confirm: The member will receive a message asking them to confirm membership, and then their status will be set to Confirm. Administrators may use this status when creating members to allow them to confirm their memberships.
needs-hello: The member will receive a message welcoming them to the list, and then their status will be Normal. Administrators may use this status when creating members to notify them they have been added.
needs-goodbye: The member will receive a message informing them they have left the list, and their status will be Unsubscribed. Administrators may use this status when unsubscribing members to notify them they have been removed.

subtype

mail: As soon as someone contributes a message to the mailing list, the user will receive a copy of that message.
digest: Each night, the user will receive a single email message containing all the messages contributed to the mailing list that day in plain-text; all HTML and attachments will be stripped. At the top of the message will be a numbered list of the subjects in that digest, followed by the complete messages themselves. Digest recipients will not receive messages sent to segments.
index: Each night, the user will receive a single email message containing all the subject lines of all the messages contributed to the mailing list that day. If any of the messages interest the user, the bottom of the index gives the email command that will retrieve the bodies of the messages.
mimedigest: The same as a digest, but in MIME format so that the individual messages' formatting is preserved. Digest recipients will not receive messages sent to segments.
nomail: No email is sent to the user. The user is free to go the web interface whenever they want, and read the full text of the messages there. This setting is useful for when members go on vacation and want to stop receiving mail.

If the member has no membership for this list, the response will be a 404 List Membership Not Found.

Sample Requests

GET /v1/member/SAMPLE123456/list/samplelist HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 LIST NOT FOUND	invalid list name
404 LIST MEMBERSHIP NOT FOUND	member has no membership for this list

Sample Response (success)

200 OK

{
    "data": {
        "count":2,
        "list": [
            {
                "listname": "samplelist",
                "membertype": "normal",
                "subtype": "mail",
                "name": "Jane Doe, Esq",
                "email": "[email protected]",
                "lockname": 1,
                "lockaddress": 0,
                "keepactive": 0,
                "api_id": 0000000,
                "x-api-uri": "/v1/member/SAMPLE123456/list/samplelist/0000000"
            },
            {
                "listname": "samplelist",
                "membertype": "normal",
                "subtype": "mail",
                "name": "Jane Doe, Esq",
                "email": "[email protected]",
                "lockname": 1,
                "lockaddress": 0,
                "keepactive": 0,
                "api_id": 0000001,
                "x-api-uri": "/v1/member/SAMPLE123456/list/samplelist/0000001"
            }
        ]
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 LIST MEMBERSHIP NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "List Membership Not Found."
    ]
}

GET

/v1/member/{membernumber}/list/{listname}/{api_id}

expand

POST

/v1/member/{membernumber}/list/{listname}

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. Only the required keys need to be provided.

email - e-mail address of the list membership (required)
name - member's name on the list (required)
lockname - 1 or 0, if the Lock Name flag to be set for this list membership (optional, defaults to 0)
lockaddress - 1 or 0, if the Lock Address flag to be set for this list membership (optional, defaults to 0)
keepactive - 1 or 0, if the Keep Active flag to be set for this list membership (optional, defaults to 0)
membertype - member type of the list membership (required). Valid values are:

normal: An active member who may receive mail from the list.
confirm: The person has requested to join this mailing list, but has not confirmed the subscription request by replying or clicking on a confirmation message. Once the member has confirmed membership, the person's status will change to normal.
private: Awaiting admin approval.
expired: Subscription has expired.
held: An undeliverable member. ListManager failed to deliver mail to this address the number of times specified for the list . A user may become "unheld" by replying to a held notification
unsub: The member has opted out of the list. The member will not receive email, but is retained in the database for statistical reasons or in case the member decides to resubscribe.
referred: Referred by a friend and awaiting confirmation.
needs-confirm: The member will receive a message asking them to confirm membership, and then their status will be set to Confirm. Administrators may use this status when creating members to allow them to confirm their memberships.
needs-hello: The member will receive a message welcoming them to the list, and then their status will be Normal. Administrators may use this status when creating members to notify them they have been added.
needs-goodbye: The member will receive a message informing them they have left the list, and their status will be Unsubscribed. Administrators may use this status when unsubscribing members to notify them they have been removed.

subtype - subscription type of the list membership (required). Valid values are:

mail: As soon as someone contributes a message to the mailing list, the user will receive a copy of that message.
digest: Each night, the user will receive a single email message containing all the messages contributed to the mailing list that day in plain-text; all HTML and attachments will be stripped. At the top of the message will be a numbered list of the subjects in that digest, followed by the complete messages themselves. Digest recipients will not receive messages sent to segments.
index: Each night, the user will receive a single email message containing all the subject lines of all the messages contributed to the mailing list that day. If any of the messages interest the user, the bottom of the index gives the email command that will retrieve the bodies of the messages.
mimedigest: The same as a digest, but in MIME format so that the individual messages' formatting is preserved. Digest recipients will not receive messages sent to segments.
nomail: No email is sent to the user. The user is free to go the web interface whenever they want, and read the full text of the messages there. This setting is useful for when members go on vacation and want to stop receiving mail.

Sample Request

POST /v1/member/SAMPLE123456/list/samplelist HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 111

{
    "email": "[email protected]",
    "name": "Jane Doe, Esq",
    "membertype": "normal",
    "subtype": "mail"
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 LIST NOT FOUND	invalid list name
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	unable to add list membership

Sample Response (success)

201 CREATED

{
    "data": {
        "count":1,
        "list": {
            "listname": "samplelist",
            "membertype": "normal",
            "subtype": "mail",
            "name": "Jane Doe, Esq",
            "email": "[email protected]",
            "lockname": 0,
            "lockaddress": 0,
            "keepactive": 0,
            "api_id": 0000000,
            "x-api-uri": "/v1/member/SAMPLE123456/list/samplelist/0000000"
        }
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to add list membership."
    ]
}

PUT

/v1/member/{membernumber}/list/{listname}/{api_id}

expand

DELETE

/v1/member/{membernumber}/list/{listname}/{api_id}

expand

/member/loginurl

POST - Returns an serialized login link for a membernumber. Login links expire 5 minutes after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

not applicable

POST

/v1/member/{membernumber}/loginurl

expand

PUT

not applicable

DELETE

not applicable

/member/merge

POST - Merge member records

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

not applicable

POST

/v1/member/{membernumber}/merge

expand

PUT

not applicable

DELETE

not applicable

/member/photo

GET - Returns the member's photo URI
PUT - Save a member's photo

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/photo

expand

POST

not applicable

PUT

/v1/member/{membernumber}/photo

expand

DELETE

not applicable

/member/sso/mcusertokenjwt

POST - Returns an JWT for MemberCentral's MCUserToken for a membernumber.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

not applicable

POST

/v1/member/{membernumber}/sso/mcusertokenjwt

expand

PUT

not applicable

DELETE

not applicable

/member/sso/zendesk

POST - Returns a JSON Web Token(JWT) for a membernumber. This token will expire 3 minutes after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

not applicable

POST

/v1/member/{membernumber}/sso/zendesk

expand

PUT

not applicable

DELETE

not applicable

/member/subscription

GET - Returns the member's subscription
POST - Creates a member's subscription
DELETE - Removes a member's subscription

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/subscription

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is an object of subkeys used to limit the subscriptions returned. Eligible subkeys are:
type_api_id is an array of the subscription type api_id
subscription_api_id is an array of the subscription api_id
rate_api_id is an array of the subscription rate api_id
frequency_api_id is an array of the subscription frequency api_id
status is an array of the subscription statuses
startdate is the start date of the subscription
enddate is the end date of the subscription
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Response Details

Each subscription listed in the response will have the following data:

x-api-uri - the URI of the member's subscription
subscriber_id - unique identifer of the member's subscription
parent_subscriber_id - subscription's parent subscriber ID, if applicable
x-parent-api-uri - the URI of the parent subscriber ID, if applicable
type - name of the subscription type
type_api_id - api_id of the subscription type
subscription - name of the subscription
subscription_api_id - api_id of the subscription
rate - name of the subscription rate
rate_api_id - api_id of the subscription rate
frequency - name of the subscription frequency
frequency_api_id - api_id of the subscription frequency
status - status of the subscription
activationstatus - activation status of the subscription
startdate - start date of the subscription
enddate - end date of the subscription
graceenddate - grace period end date of the subscription, if applicable
x-renew-uri - when the status is Billed, the URI of the renewal

Sample Requests

GET /v1/member/SAMPLE123456/subscription HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

GET /v1/member/SAMPLE123456/subscription HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 157

{
    "count": 5,
    "start": 10,
    "search": {
        "type_api_id": [
            "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        ],
        "status": [
            "Active",
            "Accepted"
        ]
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count":21,
        "subscription":[
            {
                "type": "Membership",
                "type_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "subscription": "Annual Membership",
                "subscription_api_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "rate": "Less than 5 years",
                "rate_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "frequency": "Full",
                "frequency_api_id": "WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
                "status": "Expired",
                "activationstatus": "Activation Requirement Met",
                "startdate": "08/22/2011",
                "enddate": "12/31/2011",
                "graceenddate": "03/31/2012",
                "subscriber_id": "123456",
                "parent_subscriber_id": "",
                "x-parent-api-uri": "",
                "x-api-uri": "/v1/member/SAMPLE123456/subscription/123456",
                "x-renew-uri": ""
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/member/{membernumber}/subscription/{subscriber_id}

expand

POST

/v1/member/{membernumber}/subscription

expand

Required Request Details

The request must contain a JSON object in the body with the following keys.

Required keys:
status - status of the subscription
subscription_api_id - api_id of the subscription

Optional keys:
frequency_api_id - api_id of the frequency. Defaults to Full if not provided.
rate_api_id - api_id of the rate. If not provided, we will look up rate based on eligible rate and frequency.
rate_overrideamt - overridden amount of the rate
startdate - overridden start date of the subscription
enddate - overridden end date of the subscription
graceenddate - overridden grace end date of the subscription
skipemail - true or false, defaults to false. If true, we will skip automated e-mails to Active or Accepted subscriptions.

Optionally, an addons array can be provided:
addons - an array of addons to parent subscription. Each addon can contain:
- subscription_api_id - api_id of the subscription (required)
- rate_api_id - api_id of the rate. If not provided, we will look up rate based on eligible rate and frequency.
- rate_overrideamt - overridden amount of the rate

Sample Request

POST /v1/member/SAMPLE123456/subscription HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 350

{
    "status": "Active",
    "subscription_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "frequency_api_id": "WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
    "rate_overrideamt": "195.00",
    "startdate": "8/1/2027",
    "enddate": "8/31/2027",
    "graceenddate": "8/31/2027",
    "addons": [
        {
            "subscription_api_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY"
        }
    ]
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body
500 NOT CREATED	error creating member subscription

Sample Response (success)

201 CREATED

{
    "data": {
        "result": "Member subscription creation has been scheduled successfully.",
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create member subscription.",
        ...
    ]
}

DELETE

/v1/member/{membernumber}/subscription/{subscriber_id}

expand

/member/website

GET - Returns the member's website addresses
PUT - Updates a member's website address
DELETE - Removes a member's website address

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/member/{membernumber}/website

expand

GET

/v1/member/{membernumber}/website/{api_id}

expand

POST

not applicable

PUT

/v1/member/{membernumber}/website/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with one key, website.

website is the member's website address for this website type.

Sample Request

PUT /v1/member/SAMPLE123456/website/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 46

{
    "website": "http://www.mysite.org/MyPage"
}

Possible Response Codes

200 OK	success
202 NOT UPDATED	no changes to process
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 MEMBER NOT FOUND	invalid membernumber
404 WEBSITE TYPE NOT FOUND	invalid website api_id
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating website

Sample Response (success)

200 OK

{
    "data": {
        "result": "Member updated.",
        "report": [
            "summary": [
                "1 existing member will be updated.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": [
                "LastName, NewFirstName (SAMPLE123456) - Company Website changed from http://www.mysite.org to http://www.mysite.org/MyPage",
                ...
            ]
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (no changes)

202 NOT UPDATED

{
    "data": {
        "result": "No changes to process.",
        "report": [
            "summary": [
                "1 data change was rejected and ignored.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [
                "LastName, NewFirstName (SAMPLE123456) - Company Website is not valid: http://mysite"
            ],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": []
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update member.",
        ...
    ]
}

DELETE

/v1/member/{membernumber}/website/{api_id}

expand

/memberupdate

GET - Returns the possible keys/columns to use when adding or updating member records.
POST - Upload a member file to add/update multiple member records.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/memberupdate

expand

POST

/v1/memberupdate

expand

Required Request Details

The request must contain a multi-part body with two form fields: members and options.

members is your members CSV file containing the members and columns you want to update.
options is a JSON object of the options for this member update. The supported keys are:

Required Key:
sync = partial | full

Use "partial" to send a partial list of members to add or update.
Use "full" to send a complete list of active members to sync. We will ensure all members in your file are set to Active and all Users not in your file are set to Inactive.

Optional Keys for Partial Sync:
setIncludedActive = true | false (default is false)

If "true", we will ensure all members in the uploaded file are set to Active.
If "false", status will be untouched.

generateMemberNumber = true | false (default is false)

If "true", we will ensure those without membernumbers in the uploaded file are added with auto-generated membernumbers.
If "false", members missing membernumbers will prevent the update.

ignoreInvalidColumns = true | false (default is true)

If "true", we will ignore invalid columns in the uploaded file.
If "false", we will prevent the update if any invalid columns are found in the uploaded file.

Optional Keys for Full Sync:
inactivateThreshold = 500 (default is 500)

We will prevent the update if more than this number of members will be inactivated.

ignoreInvalidColumns = true | false (default is true)

If "true", we will ignore invalid columns in the uploaded file.
If "false", we will prevent the update if any invalid columns are found in the uploaded file.

Sample Request

POST /v1/memberupdate HTTP/1.1
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 221

-----011000010111000001101001
Content-Disposition: form-data; name="members"


-----011000010111000001101001
Content-Disposition: form-data; name="options"

{
    "sync":"partial"
}
-----011000010111000001101001--

Possible Response Codes

200 OK	success
202 NOT UPDATED	no changes to process
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
406 NOT ACCEPTABLE	unable to process file
417 EXPECTATION FAILED	invalid JSON object, missing file, or invalid file

Sample Response (success)

200 OK
{
    "data": {
        "result": "Upload accepted."
        "report": [
            "summary": [
                "1 existing member will be updated.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": [
                "LastName, NewFirstName (SAMPLE123456) - First name changed from Pat to NewFirstName",
                ...
            ]
        ]
    },
    "error":false,
    "messages":[]
}

Sample Response (no changes)

202 NOT UPDATED

{
    "data": {
        "result": "No changes to process.",
        "report": [
            "summary": [
                "1 data change was rejected and ignored.",
                ...
            ],
            "files": [
               "<a href=\"http://www.mysite.org/LINK_TO_FILE\">Submitted Data", 
               ...
            ],
            "rejected": [
                "LastName, NewFirstName (SAMPLE123456) - website is not valid: http://mysite"
            ],
            "newmembers": [],
            "guestmembers": [],
            "existingmembers": []
        ]
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

406 NOT ACCEPTABLE

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to process member file.",
        ...
    ]
}

Sample Response (failure)

417 EXPECTATION FAILED

{
    "data": {},
    "error": true,
    "messages": [
        "Invalid file type.",
        "Only CSV files are accepted.",
        ...
    ]
}

PUT

not applicable

DELETE

not applicable

/organization/sso/mcusertokensecret

MemberCentral's MCUserToken Secret is used to generate a JSON Web Token (JWT) both in direct calls to /member/{membernumber}/sso/mcusertokenjwt and in post-login redirection when a returnURL is specified.

When linking to a site's login page, there is an option to pass in a returnURL parameter. Upon successful login, we will redirect the user back to that returnURL. If a MCUserToken Secret is defined for the organization, we will pass along a JWT payload, allowing you to parse the JWT using the MCUserToken Secret to obtain the membernumber of the member that just logged in. The structure of the JWT payload is defined in /member/sso/mcusertokenjwt.

Example: If your site directs members to the login page at
http://yourassociation.org/?pg=login&returnURL=https%3A%2F%2Fcle.yourassociation.org%2Fmyaccount
and the MCUserToken Secret is defined, we will redirect the member back to
https://cle.yourassociation.org/myaccount?mcusertoken=XXXX....XXXX

GET - Returns the user token secret key
PUT - Sets the user token secret key
DELETE - Clears the user token secret key

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/organization/sso/mcusertokensecret

expand

POST

not applicable

PUT

/v1/organization/sso/mcusertokensecret

expand

DELETE

/v1/organization/sso/mcusertokensecret

expand

/phone

GET - Returns phone types
POST - Creates a phone type
PUT - Updates a phone type
DELETE - Deletes a phone type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/phone

expand

GET

/v1/phone/{api_id}

expand

POST

/v1/phone

expand

PUT

/v1/phone/{api_id}

expand

DELETE

/v1/phone/{api_id}

expand

/referral

GET - Returns referrals
POST - Creates one or more referrals
PUT - Updates a referral
PATCH - Reopens or activates a referral
DELETE - Deletes a pending referral

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/referral

expand

Optional Request Details

The request may optionally contain a JSON object in the body with one or more of the following keys:

start is the 0-based position of the overall resultset the results should start with. The default when not provided is 0.
count is the number of results to include in the response. The default when not provided is 10.
search is a structure of subkeys used to limit the referrals returned. Eligible subkeys are:
calldatefrom - call date on or after this date
calldateto - call date on or before this date
calluid - the unique identifer of the call
clientfirstname - client's first name
clientemail - client's email
clientlastname - client's last name
clientphone - client's phone number
counselorfirstname - counselor's first name
counselorlastname - counselor's last name
feediscrepancystatus - the fee discrepancy status
hasdocuments - if the referral has documents (true or false)
istransferred - if the referral is transferred (true or false)
lawyerfirstname - lawyer's first name
lawyerlastname - lawyer's last name
notefollowupdatefrom - note follow up date on or after this date
notefollowupdateto - note follow up date on or before this date
notefollowupstatus - the follow up status of note (either pending or completed)
refdatefrom - referral date on or after this date
refdateto - referral date on or before this date
referralnum - the system generated referral number
repfirstname - representative's first name
replastname - representative's last name
status - the referral status. Use statusname from GET /referral/status for the valid options.
transferdatefrom - transfer date on or after this date
transferdateto - transfer date on or before this date
If your JSON object contains invalid search subkeys, an ignoredfields array is returned in the response.

Sample Requests

GET /v1/referral HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 29

{
    "count": 5,
    "start": 0,
    "search": {
        "refdateto": "7/4/2026"
    }
}

GET /v1/referral HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 97

{
    "count": 5,
    "start": 10,
    "search": {
        "clientfirstname": "Michael",
        "clientlastname": "Smith",
        "email": "[email protected]",
        "lawyerfirstname": "John",
        "lawyerlastname": "Doe",
        "repfirstname": "David",
        "replastname": "Johnson",
        "status": "Open- Retained",
        "counselorfirstname": "William",
        "counselorlastname": "Davis",
        "refdatefrom": "6/4/2026",
        "refdateto": "7/4/2026",
        "calldatefrom": "6/4/2026",
        "calldateto": "7/4/2026",
        "notefollowupdatefrom": "6/4/2026",
        "notefollowupdateto": "7/4/2026",
        "notefollowupstatus": "Pending",
        "referralnum": "4010752",
        "calluid": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "phonenumber": "123-321-3535",
        "feediscrepancystatus": "Confirmed Discrepancy",
        "istransferred": "1",
        "transferdatefrom": "6/4/2026",
        "transferdateto": "7/4/2026",
        "hasdocuments": "1"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body

Sample Response (success)

200 OK

{
    "data": {
        "count": 5,
        "referrals": [
            {
                "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-api-uri": "/v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-referraladmin-uri": "https://yourassociation.org/[path-to-referral]",
                "status": "Open - Retained",
                "clientfirstname": "Michael",
                "clientlastname": "Smith",
                "clientreferraldate": "6/3/2026",
                "lawyername": "John Doe",
                "membernumber": "SAMPLE123456",
                "islawyerreferral": 1,
                "isdeleted": 0
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/referral/{api_id}

expand

Sample Request

GET /v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 REFERRAL NOT FOUND	invalid referral api_id

Sample Response - Not Referred (success)

200 OK

{
    "data": {
        "count": 1,
        "referral": {
            "calldate": "1/1/2024 11:04 AM",
            "lastupdateddate": "3/1/2024 4:16 PM",
            "referraldate": "1/4/2024 11:08 AM",
            "caseopendate": "2/1/2024 2:00 PM",
            "casecloseddate": "3/1/2024 4:16 PM",
            "source": "Web / Internet",
            "language": "English",
            "legalissue": "Family Law: Divorce With Children involved",
            "agreesurvey": 1,
            "agreenewsletter": 0,
            "isreferred": 0,
            "caseexists": 0,
            "client": {
                "clientfirstname": "Sally",
                "clientmiddlename": "",
                "clientlastname": "Smith",
                "clientcompany": "",
                "clientemail": "[email protected]",
                "clientaddress1": "123 AnyStreet",
                "clientaddress2": "",
                "clientcity": "Anytown",
                "clientstateprov": "Texas",
                "clientpostalcode": "78735",
                "clientphonehome": "",
                "clientphonecell": "555-555-5555",
                "clientphonealternate": ""
            },
            "representative": {
                "repfirstname": "",
                "replastname": "",
                "repaddress1": "",
                "repaddress2": "",
                "repcity": "",
                "repstateprov": "",
                "reppostalcode": "",
                "repemail": "",
                "repphonehome": "",
                "repphonecell": "",
                "repphonealternate": "",
                "relationtoclient": ""
            },
            "counselor": {
                "counselorfirstname": "Tammy",
                "counselorlastname": "Thompson",
                "counselormembernumber": "ABC123456"
            },
            "call": {
                "calltype": "Lawyer Referral",
                "callid": "XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX"
            },
            "clientfeesinfo": {
                "clientfees": [
                    {
                        "date": "9/11/2024",
                        "fee": "8.00",
                        "amounttobepaid": "0.00",
                        "paidtodate": "8.00"
                    }
                ],
                "clientfeestotals": {
                    "fee": "8.00",
                    "amounttobepaid": "0.00",
                    "paidtodate": "8.00"
                }
            },
            "counselornotes": [
                {
                    "enteredby": "John Doe",
                    "createddate": "09/26/2024 12:00 AM",
                    "followupstatus": "Completed",
                    "followupdate": "10/26/2024",
                    "description": "This is a test counselor note."
                },
                ...
            ],
            "agencyname": "Legal Shield",
            "referralstatus": "Pending - Referral NOT sent",
            "filters": {
                "primarypanel": "Criminal Law",
                "primarysubpanel": "Bank Robbery|Tax Evasion",
                "secondarypanel": "",
                "secondarysubpanel": "N/A",
                "tertiarypanel": "",
                "tertiarysubpanel": "N/A",
                "customfields": [
                    {
                        "value": "John",
                        "label": "First Name"
                    },
                    {
                        "value": "01/01/1988",
                        "label": "Date Of Birth"
                    },
                    {
                        "value": "English|German|French",
                        "label": "Languages"
                    },
					...
                ],
                "classifications": [
                    {
                        "value": "Board Members",
                        "label": "Classification"
                    },
                    {
                        "value": "Less than 5 Years in Practice|Over 10 Years in Practice",
                        "label": "Membership Level"
                    },
					...
                ]
            },
            "questionanswerpath": "Select a Panel / Administrative / Yes or No / Yes /",
            "clientcustomfields": {
                "fieldgroupings": [
                    {
                        "ungrouped": 1,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "Attorney referred me",
                                "label": "How did you hear about us?"
                            },
                            ...
                        ],
                        "groupname": ""
                    },
                    {
                        "ungrouped": 0,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "No",
                                "label": "Do you need special accommodations?"
                            },
                            ...
                        ],
                        "groupname": "Optional Information"
                    },
                    ...
                ]
            },
            "x-activate-api-uri": "/v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-reopen-api-uri": "/v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-delete-api-uri": "/v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
    },
    "error":false,
    "messages":[]
}

Sample Response - Referred (success)

200 OK

{
    "data": {
        "count": 1,
        "referral": {
            "calldate": "1/1/2024 11:04 AM",
            "lastupdateddate": "3/1/2024 4:16 PM",
            "referraldate": "1/4/2024 11:08 AM",
            "caseopendate": "2/1/2024 2:00 PM",
            "casecloseddate": "3/1/2024 4:16 PM",
            "source": "Web / Internet",
            "language": "English",
            "legalissue": "Family Law: Divorce With Children involved",
            "agreesurvey": 1,
            "agreenewsletter": 0,
            "isreferred": 1,
            "caseexists": 1,
            "client": {
                "clientfirstname": "Sally",
                "clientmiddlename": "",
                "clientlastname": "Smith",
                "clientcompany": "",
                "clientemail": "[email protected]",
                "clientaddress1": "123 AnyStreet",
                "clientaddress2": "",
                "clientcity": "Anytown",
                "clientstateprov": "Texas",
                "clientpostalcode": "78735",
                "clientphonehome": "",
                "clientphonecell": "555-555-5555",
                "clientphonealternate": ""
            },
            "representative": {
                "repfirstname": "",
                "replastname": "",
                "repaddress1": "",
                "repaddress2": "",
                "repcity": "",
                "repstateprov": "",
                "reppostalcode": "",
                "repemail": "",
                "repphonehome": "",
                "repphonecell": "",
                "repphonealternate": "",
                "relationtoclient": ""
            },
            "counselor": {
                "counselorfirstname": "Tammy",
                "counselorlastname": "Thompson",
                "counselormembernumber": "ABC123456"
            },
            "call": {
                "calltype": "Lawyer Referral",
                "callid": "XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX"
            },
            "lawyer": {
                "lawyerfirstname": "J",
                "lawyerlastname": "Williams",
                "lawyermembernumber": "DEF987654"
            },
            "lawyernotes": [
                {
                    "enteredby": "John Doe",
                    "createddate": "09/26/2024 12:00 AM",
                    "followupstatus": "Completed",
                    "followupdate": "10/26/2024",
                    "description": "This is a test lawyer note."
                },
                ...
            ],
            "feetype": "Consultation",
            "case": {
                "feediscrepanciesstatuslogs": [
                    {
                        "date": "10/01/2024",
                        "notes": "Not Resolved",
                        "enteredby": "John Doe",
                        "status": "No Resolution Reached"
                    },
                    ...
                ],
                "feesreportedbyclient": "0.00"
                "attorney": {
                    "attorneymembernumber": "ZZ20110628170200",
                    "attorneyfirstname": "J",
                    "attorneylastname": "Williams"
                },
                "casefeesinfo": {
                    "casefeestotals": {
                        "filingfee": "0.00",
                        "collectedfee": "11,500.00",
                        "referraldues": "30.00",
                        "amounttobepaid": "0.00"
                    },
                    "casefees": [
                        {
                            "filingfee": "0.00",
                            "collectedfee": "1,000.00",
                            "referraldues": "10.00",
                            "amounttobepaid": "0.00",
                            "collectedfeedate": "9/23/2024"
                        },
                        ...
                    ]
                },
                "status": "Closed - Final Payment"
            }
            "clientfeesinfo": {
                "clientfees": [
                    {
                        "date": "9/11/2024",
                        "fee": "8.00",
                        "amounttobepaid": "0.00",
                        "paidtodate": "8.00"
                    }
                ],
                "clientfeestotals": {
                    "fee": "8.00",
                    "amounttobepaid": "0.00",
                    "paidtodate": "8.00"
                }
            },
            "consultationfeesinfo": {
                "consultationfeestotals": {
                    "fee": "25.00",
                    "amounttobepaid": "0.00",
                    "paidtodate": "25.00"
                },
                "consultationfees": [
                    {
                        "date": "9/12/2024",
                        "fee": "25.00",
                        "amounttobepaid": "0.00",
                        "paidtodate": "25.00"
                    }
                ]
            },
            "counselornotes": [
                {
                    "enteredby": "John Doe",
                    "createddate": "09/26/2024 12:00 AM",
                    "followupstatus": "Completed",
                    "followupdate": "10/26/2024",
                    "description": "This is a test counselor note."
                },
                ...
            ],
            "agencyname": "Legal Shield",
            "filters": {
                "primarypanel": "Criminal Law",
                "primarysubpanel": "Bank Robbery|Tax Evasion",
                "secondarypanel": "",
                "secondarysubpanel": "N/A",
                "tertiarypanel": "",
                "tertiarysubpanel": "N/A",
                "customfields": [
                    {
                        "value": "John",
                        "label": "First Name"
                    },
                    {
                        "value": "01/01/1988",
                        "label": "Date Of Birth"
                    },
                    {
                        "value": "English|German|French",
                        "label": "Languages"
                    },
                    {
                        "value": "Within 5 miles of Postal Code 12345",
                        "label": "Postal Code"
                    }
                ],
                "classifications": [
                    {
                        "value": "Board Members",
                        "label": "Classification"
                    },
                    {
                        "value": "Less than 5 Years in Practice|Over 10 Years in Practice",
                        "label": "Membership Level"
                    }
                ]
            },
            "attorneycustomfields": {
                "fieldgroupings": [
                    {
                        "ungrouped": 0,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "What is the best way to reach you?",
                                "label": "Email"
                            },
                            ...
                        ],
                        "groupname": "Contact Information"
                    },
                    ...
                ]
            },
            "questionanswerpath": "Select a Panel / Administrative / Yes or No / Yes /",
            "clientcustomfields": {
                "fieldgroupings": [
                    {
                        "ungrouped": 1,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "Attorney referred me",
                                "label": "How did you hear about us?"
                            },
                            ...
                        ],
                        "groupname": ""
                    },
                    {
                        "ungrouped": 0,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "No",
                                "label": "Do you need special accommodations?"
                            },
                            ...
                        ],
                        "groupname": "Optional Information"
                    },
                    ...
                ]
            }
        }
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 REFERRAL NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Referral not found."
    ]
}

POST

/v1/referral

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. Only the required keys need to be provided.

Attorney Referrals

referralcreated - referral created date (required)
referralsourcecode - source's import code (required)
language - language (required)
primarypanel - panel code (required when primary status is not Pending - Referral NOT Sent)
membernumberattorney - member number of attorney (required when primary status is not Pending - Referral NOT Sent)
createdby - member number of created by member (required)
referralstatuscode - status's import code (required)
legalIssue - description (required)
clientfirstname - first name (required)
clientmiddlename - middle name (optional)
clientlastname - last name (required)
clientbusinessname - business name (optional)
clientaddress1 - address 1 (optional)
clientaddress2 - address 2 (optional)
clientaddress3 - address 3 (optional)
clientcity - city (optional)
clientstate - state code (optional)
clientpostalcode - postal code (optional)
clientcountry - county (optional)
clientemail - valid email (optional)
clienthomephone - home phone (optional)
clientcellphone - cell phone (optional)
clientalternatephone - alternate phone (optional)
survey - Client agrees to receive surveys regarding the case? YES/NO (optional)
primarysubpanel - pipe (|) delimited list of sub-panel codes (optional)
secondarypanel - panel code (optional)
secondarysubpanel - pipe (|) delimited list of sub-panel codes (optional)
tertiarypanel - panel code (optional)
tertiarysubpanel - pipe (|) delimited list of sub-panel codes (optional)
retaineddt - retained date, required if referral was retained at some point (optional)
lrsfeetype - fee type name (optional)
closeddate - closed date (optional)
counselornotes - counselor notes (optional)
lawyernotes - lawyer notes (optional)

Agency Referrals

referralcreated - referral created date (required)
referralsourcecode - source's import code (required)
language - language (required)
createdby - member number of created by member (required)
referralstatuscode - status's import code (required)
legalIssue - description (required)
agency - agency's import code (required)
clientfirstname - first name (required)
clientmiddlename - middle name (optional)
clientlastname - last name (required)
clientbusinessname - business name (optional)
clientaddress1 - address 1 (optional)
clientaddress2 - address 2 (optional)
clientaddress3 - address 3 (optional)
clientcity - city (optional)
clientstate - state code (optional)
clientpostalcode - postal code (optional)
clientcountry - county (optional)
clientemail - valid email (optional)
clienthomephone - home phone (optional)
clientcellphone - cell phone (optional)
clientalternatephone - alternate phone (optional)
survey - Client agrees to receive surveys regarding the case? YES/NO (optional)
counselornotes - counselor notes (optional)

Sample Request

POST /v1/referral HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 427

{
    "referrals":[
        {
            "clientfirstname": "John",
            "clientlastname": "Doe",
            "referralcreated":"6/4/2026",
            "referralSourceCode":"attorney",
            "clientemail": "[email protected]",
            "language":"english",
            "primarypanel": "admin",
            "membernumberattorney": "SAMPLE456789",
            "createdby":"SAMPLE123456",
            "referralstatuscode": "PendNotSend",
            "legalissue":"Wrongful employment dismissal "
        }
        ...
    ]
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
500 NOT CREATED	Unable to create referrals.

Sample Response (success)

201 CREATED

{
    "data": {
        "count": 2,
        "result": "Referrals created."
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create referral.",
        "Row 1: Attorney Member Number does not match an existing member.",
        "Row 2: Legal Issue is required. [legalissue]"
    ]
}

PUT

/v1/referral/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. You only need to provide the keys for data you wish to update.

source - source of the referral
othersource - other source name (valid only if the value of source is 'Other')
language - referral language
legalissue - issue description
agreesurvey - if client agrees to receive surveys regarding the case? (true or false)
agreenewsletter - if client agrees to receive e-mails regarding Newsletters and/or Blog updates? (true or false)
client is a structure of subkeys used to update client information. Eligible subkeys are:

clientfirstname - client's first name
clientmiddlename - client's middle name
clientlastname - client's last name
clientcompany - client's business name
clientaddress1 - client's address line 1
clientaddress2 - client's address line 2
clientcity - client's city
clientstateprov - client's state
clientpostalcode - client's zip code
clientemail - client's email
clientphonehome - client's home phone
clientphonecell - client's cell phone
clientphonealternate - client's alternate phone

representative is a structure of subkeys used to update representative information. Eligible subkeys are:

repfirstname - representative's first name
replastname - representative's last name
relationtoclient - representative's relation to client
repaddress1 - representative's address line 1
repaddress2 - representative's address line 2
repcity - representative's city
repstateprov - representative's state
reppostalcode - representative's zip code
repemail - representative's email
repphonehome - representative's home phone
repphonecell - representative's cell phone
repphonealternate - representative's alternate phone

call is a structure of subkeys used to update call information. Eligible subkeys are:

calltype - call type name

agencyname - name of the agency (valid only if calltype is 'Referral to Agency')
otheragency - new agency name (valid only if calltype is 'Referral to Agency')
feetype - fee type name (valid only if case exists and Allow Fee Type Management setting is enabled)
referralstatus - status of referral (valid only if case does not exists)
case is a structure of subkeys used to update case information (valid only if case exists). Eligible subkeys are:

status - status of case
feesreportedbyclient - fees reported by client

filters is a structure of subkeys used to update referral filters (valid only if isreferred is 0 and calltype is not 'Referral to Agency'). Eligible subkeys are:

primarypanel - primary panel name
primarysubpanel - primary sub-panel names separated by pipe symbol
secondarypanel - secondary panel name
secondarysubpanel - secondary sub-panel names separated by pipe symbol
tertiarypanel - tertiary panel name
tertiarysubpanel - tertiary sub-panel names separated by pipe symbol
customfields - an array of member fields (present in the 'Field Set for Filter Tab' selection) passed in as label and value pairs
classifications - an array of defined classifications entries passed in as label and value pairs

attorneycustomfields - an array of custom fields (Attorney Fields) passed in as field_api_id and value pairs (valid only if isreferred is 1), with no grouping specified.
clientcustomfields - an array of custom fields (Extra Information) passed in as field_api_id and value pairs, with no grouping specified.

Sample Request - Not Referred

PUT /v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 1511

{
    "source":"Website",
    "language": "English",
    "legalissue": "Family Law: Divorce with Children and Custody Matters",
    "agreenewsletter": 1,
    "client": {
        "clientmiddlename": "Elizabeth",
        "clientphonealternate": "666-666-666"
    },
    "representative": {
        "repfirstname": "Michael",
        "replastname": "Smith",
        "relationtoclient": "Brother",
        "repemail": "[email protected]",
        "repcity": "Anytown",
        "repstateprov": "Texas",
        "reppostalcode": "78735",
        "repphonecell": "777-777-7777"
    },
    "call": {
        "calltype": "Lawyer Referral"
    },
    "filters": {
        "primarypanel": "Family Law",
        "primarysubpanel": "Custody and Modification|Child Support",
        "secondarypanel": "Guardianship",
        "customfields": [
            {
                "value": "Texas",
                "label": "Primary Address State"
            },
            {
                "value": "English|German|French",
                "label": "Languages"
            },
            {
                "value": "7/4/2026",
                "label": "Earliest Bar Date"
            }
        ],
        "classifications": [
            {
                "value": "Guardianship|Administrative Law|Civil Litigation",
                "label": "Areas of Practice"
            },
            {
                "value": "5-10 Years in Practice",
                "label": "Membership Level"
            }
        ]
    },
    "attorneycustomfields": [
        {
            "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "value": "10/01/2024"
        },
        {
            "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "value": "Law School|Courthouse"
        }
    ],
    "clientcustomfields": [
        {
            "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "value": "No"
        },
        {
            "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "value": "Telephone|Email|Website"
        }
    ]
}

Sample Request - Case Exists

PUT /v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 203

{
    "source":"Other",
    "othersource":"Former Clients",
    "legalissue": "Criminal Defense - Assault Charges",
    "agreenewsletter":1,
    "feetype":"Hourly Fee",
    "case": {
        "status": "Closed - Retained",
        "feesreportedbyclient": "1500.00"
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 REFERRAL NOT FOUND	invalid referral api_id
406 NOT ACCEPTABLE	invalid input data
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating referral

Sample Response (success)

200 OK

{
    "data": {
        "count": 1,
        "ignoredfields": [],
        "referral": {
            "calldate": "1/1/2024 11:04 AM",
            "lastupdateddate": "3/1/2024 4:16 PM",
            "referraldate": "1/4/2024 11:08 AM",
            "caseopendate": "2/1/2024 2:00 PM",
            "casecloseddate": "3/1/2024 4:16 PM",
            "source":"Website",
            "language": "English",
            "legalissue": "Family Law: Divorce with Children and Custody Matters",
            "agreesurvey": 1,
            "agreenewsletter": 1,
            "isreferred": 0,
            "caseexists": 0,
            "client": {
                "clientfirstname": "Sally",
                "clientmiddlename": "Elizabeth",
                "clientlastname": "Smith",
                "clientcompany": "",
                "clientemail": "[email protected]",
                "clientaddress1": "123 AnyStreet",
                "clientaddress2": "",
                "clientcity": "Anytown",
                "clientstateprov": "Texas",
                "clientpostalcode": "78735",
                "clientphonehome": "",
                "clientphonecell": "555-555-5555",
                "clientphonealternate": "666-666-666"
            },
            "representative": {
                "repfirstname": "Michael",
                "replastname": "Smith",
                "repaddress1": "",
                "repaddress2": "",
                "repcity": "Anytown",
                "repstateprov": "Texas",
                "reppostalcode": "78735",
                "repemail": "[email protected]",
                "repphonehome": "",
                "repphonecell": "777-777-7777",
                "repphonealternate": "",
                "relationtoclient": "Brother"
            },
            "counselor": {
                "counselorfirstname": "Tammy",
                "counselorlastname": "Thompson",
                "counselormembernumber": "ABC123456"
            },
            "call": {
                "calltype": "Lawyer Referral",
                "callid": "XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXXX"
            },
            "clientfeesinfo": {
                "clientfees": [
                    {
                        "date": "9/11/2024",
                        "fee": " $8.00",
                        "amounttobepaid": " $0.00",
                        "paidtodate": " $8.00"
                    }
                ],
                "clientfeestotals": {
                    "fee": " $8.00",
                    "amounttobepaid": " $0.00",
                    "paidtodate": " $8.00"
                }
            },
            "counselornotes": [
                {
                    "enteredby": "John Doe",
                    "createddate": "09/26/2024 12:00 AM",
                    "followupstatus": "Completed",
                    "followupdate": "10/26/2024",
                    "description": "This is a test counselor note."
                },
                ...
            ],
            "agencyname": "Legal Shield",
            "referralstatus": "Pending - Referral NOT sent",
            "filters": {
                "primarypanel": "Criminal Law",
                "primarysubpanel": "Bank Robbery|Tax Evasion",
                "secondarypanel": "",
                "secondarysubpanel": "N/A",
                "tertiarypanel": "",
                "tertiarysubpanel": "N/A",
                "customfields": [
                    {
                        "value": "John",
                        "label": "First Name"
                    },
                    {
                        "value": "01/01/1988",
                        "label": "Date Of Birth"
                    },
                    {
                        "value": "English|German|French",
                        "label": "Languages"
                    },
                    ...
                ],
                "classifications": [
                    {
                        "value": "Board Members",
                        "label": "Classification"
                    },
                    {
                        "value": "Less than 5 Years in Practice|Over 10 Years in Practice",
                        "label": "Membership Level"
                    },
                    ...
                ]
            },
            "questionanswerpath": "Select a Panel / Administrative / Yes or No / Yes /",
            "clientcustomfields": {
                "fieldgroupings": [
                    {
                        "ungrouped": 1,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "Attorney referred me",
                                "label": "How did you hear about us?"
                            },
                            ...
                        ],
                        "groupname": ""
                    },
                    {
                        "ungrouped": 0,
                        "fields": [
                            {
                                "field_api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "value": "No",
                                "label": "Do you need special accommodations?"
                            },
                            ...
                        ],
                        "groupname": "Optional Information"
                    },
                    ...
                ]
            }
        }
        "result": "Referral updated."
    },
    "error": false,
    "messages": []
}

Sample Response - Invalid Input (failure)

406 NOT ACCEPTABLE

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update referral.",
        "Invalid source.",
        "Invalid representative state.",
        "Invalid call type."
    ]
}

Sample Response - Internal Error (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update referral."
    ]
}

PATCH

/v1/referral/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the following key.

op - the operation to perform, either "activate" or "reopen"

Sample Request - Activate Referral

PATCH /v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 17

{
    "op":"activate"
}

Sample Request - Re-open Referral

PATCH /v1/referral/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 15

{
    "op":"reopen"
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 REFERRAL NOT FOUND	invalid referral api_id
406 NOT ACCEPTABLE	invalid patch request
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	error updating referral

Sample Response (success)

200 OK

{
    "data": {
        "count": 1,
        "referral": {
            "calldate": "1/1/2024 11:04 AM",
            "lastupdateddate": "3/1/2024 4:16 PM",
            "referraldate": "1/4/2024 11:08 AM",
            "caseopendate": "2/1/2024 2:00 PM",
            "casecloseddate": "3/1/2024 4:16 PM",
            "source":"Website",
            "language": "English",
            "legalissue": "Family Law: Divorce with Children and Custody Matters",
            "agreesurvey": 1,
            "agreenewsletter": 1,
            "isreferred": 0,
            "caseexists": 0,
            "referralstatus": "Pending - Referral NOT sent",
            ...
        }
        "result": "Referral activated."
    },
    "error": false,
    "messages": []
}

Sample Response - Invalid Input (failure)

406 NOT ACCEPTABLE

{
    "data": {},
    "error": true,
    "messages": [
        "Invalid patch request."
    ]
}

Sample Response - Internal Error (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to apply patch to the referral."
    ]
}

DELETE

/v1/referral/{api_id}

expand

/referral/counselornote

GET - Returns the referral's counselor notes
POST - Created a referral's counselor note

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/referral/{api_id}/counselornote

expand

POST

/v1/referral/{api_id}/counselornote

expand

/referral/status

GET - Returns referral statuses

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/referral/status

expand

/subscription/frequency

GET - Returns subscription frequencies
POST - Create subscription frequency
PUT - Update subscription frequency
DELETE - Delete subscription frequency

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/subscription/frequency

expand

GET

/v1/subscription/frequency/{api_id}

expand

POST

/v1/subscription/frequency

expand

PUT

/v1/subscription/frequency/{api_id}

expand

DELETE

/v1/subscription/frequency/{api_id}

expand

/subscription/rateschedule

GET - Returns subscription rate schedules
POST - Create subscription rate schedule
PUT - Update subscription rate schedule
DELETE - Delete subscription rate schedule

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/subscription/rateschedule

expand

GET

/v1/subscription/rateschedule/{api_id}

expand

POST

/v1/subscription/rateschedule

expand

PUT

/v1/subscription/rateschedule/{api_id}

expand

DELETE

/v1/subscription/rateschedule/{api_id}

expand

/subscription/type

GET - Returns subscription types
POST - Create subscription type
PUT - Update subscription type
DELETE - Delete subscription type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/subscription/type

expand

GET

/v1/subscription/type/{api_id}

expand

POST

/v1/subscription/type

expand

PUT

/v1/subscription/type/{api_id}

expand

DELETE

/v1/subscription/type/{api_id}

expand

/subscription/type/{api_id}/subscription

GET - Returns subscriptions by subscription type
GET - Returns subscription
POST - Create subscription
PUT - Update subscription
DELETE - Delete subscription

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/subscription/type/{api_id}/subscription

expand

Response Details

Each subscription definition included in the response will have the same data structure as the GET /v1/subscription/type/{api_id}/subscription/{sub_api_id} response.

Sample Request

GET /v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 SUBSCRIPTION TYPE NOT FOUND	invalid subscription type api_id

Sample Response (success)

200 OK

{
    "data": {
        "count": 2,
        "subscriptions": [
            {
                "subscription": "Basic Membership",
                "api_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "x-api-uri": "/v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
                "schedulename": "Membership Rates",
                "schedule_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "x-schedule-api-uri": "/v1/subscription/rateschedule/ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
                "autoexpire": 0,
                "soldseparate": 0,
                "ratetermdatecode": "A",
                "ratetermdatedesc": "Adhere to term dates in rate",
                "paymentorder": 1,
                "reportcode": "BASICMEMBERS",
                "activationcode": "F",
                "activationdesc": "Follow Parent",
                "altactivationcode": "I",
                "altactivationdesc": "First Invoice For Subscription Paid",
                "allowrateglaccountoverride": 1,
                "glaccount_api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
                "glaccountname": "Membership Revenue",
                "frontendcontent": "",
                "frontendcompletedcontent": "",
                "frontendparentsubcontent": ""
            }
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/subscription/type/{api_id}/subscription/{sub_api_id}

expand

POST

/v1/subscription/type/{api_id}/subscription

expand

Required Request Details

The request must contain a JSON object in the body with the following keys.

subscription - name of the subscription (required, max 100 characters, must be unique within the subscription type)
schedule_api_id - api_id of the rate schedule (required)
ratetermdatecode - term date behavior: A = Adhere to term dates in rate, S = Use current day as term start date, C = Calculate term end date for term length (required)
autoexpire - automatically expire subscribers when term ends: 0 or 1 (required)
soldseparate - sold separately from parent subscription: 0 or 1 (required)
status - A = Active, I = Inactive (required)
glaccount_api_id - api_id of the GL account for revenue (required)
paymentorder - payment processing order, must be greater than 0 (required)
activationcode - activation option code (required)
altactivationcode - alternate activation option code; cannot be F (Follow Parent) when soldseparate is 1 (required)
reportcode - report code label, max 15 characters (optional)
allowrateglaccountoverride - allow rate-level GL account override: 0 or 1 (optional, default 0)
frontendcontent - front end content HTML (optional)
frontendcompletedcontent - front end completed content HTML (optional)
frontendparentsubcontent - front end parent subscription content HTML (optional)

Sample Request

POST /v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

{
    "subscription": "Basic Membership",
    "schedule_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
    "ratetermdatecode": "A",
    "autoexpire": 0,
    "soldseparate": 0,
    "status": "A",
    "glaccount_api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
    "paymentorder": 1,
    "activationcode": "I",
    "altactivationcode": "I",
    "reportcode": "BASICMEMBERS"
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 SUBSCRIPTION TYPE NOT FOUND	invalid subscription type api_id
417 EXPECTATION FAILED	missing or invalid JSON body
500 NOT CREATED	error creating subscription

Sample Response (success)

201 CREATED

{
    "data": {
        "result": "Subscription created.",
        "count": 1,
        "subscription": {
            "subscription": "Basic Membership",
            "api_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "x-api-uri": "/v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "schedulename": "Membership Rates",
            "schedule_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
            "x-schedule-api-uri": "/v1/subscription/rateschedule/ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
            "autoexpire": 0,
            "soldseparate": 0,
            "ratetermdatecode": "A",
            "ratetermdatedesc": "Adhere to term dates in rate",
            "paymentorder": 1,
            "reportcode": "BASICMEMBERS",
            "activationcode": "I",
            "activationdesc": "First Invoice For Subscription Paid",
            "altactivationcode": "I",
            "altactivationdesc": "First Invoice For Subscription Paid",
            "allowrateglaccountoverride": 0,
            "glaccount_api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            "glaccountname": "Membership Revenue",
            "frontendcontent": "",
            "frontendcompletedcontent": "",
            "frontendparentsubcontent": ""
        }
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create subscription.",
        ...
    ]
}

PUT

/v1/subscription/type/{api_id}/subscription/{sub_api_id}

expand

Required Request Details

The request must contain a JSON object in the body with at least one of the following keys. Only the keys provided will be updated; all others retain their current values.

subscription - name of the subscription (max 100 characters, must be unique within the subscription type)
schedule_api_id - api_id of the rate schedule
ratetermdatecode - term date behavior: A = Adhere to term dates in rate, S = Use current day as term start date, C = Calculate term end date for term length
autoexpire - automatically expire subscribers when term ends: 0 or 1
soldseparate - sold separately from parent subscription: 0 or 1
status - A = Active, I = Inactive
glaccount_api_id - api_id of the GL account for revenue
paymentorder - payment processing order, must be greater than 0
activationcode - activation option code
altactivationcode - alternate activation option code; cannot be F (Follow Parent) when soldseparate is 1
reportcode - report code label, max 15 characters
allowrateglaccountoverride - allow rate-level GL account override: 0 or 1
frontendcontent - front end content HTML
frontendcompletedcontent - front end completed content HTML
frontendparentsubcontent - front end parent subscription content HTML

Sample Request

PUT /v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

{
    "subscription": "Updated Membership",
    "status": "A"
}

Possible Response Codes

200 UPDATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 SUBSCRIPTION TYPE NOT FOUND	invalid subscription type api_id
404 SUBSCRIPTION NOT FOUND	invalid subscription api_id
417 EXPECTATION FAILED	missing or invalid JSON body
500 NOT UPDATED	error updating subscription

Sample Response (success)

200 UPDATED

{
    "data": {
        "result": "Subscription updated.",
        "count": 1,
        "subscription": {
            "subscription": "Updated Membership",
            "api_id": "YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "x-api-uri": "/v1/subscription/type/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/subscription/YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY",
            "schedulename": "Membership Rates",
            "schedule_api_id": "ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
            "x-schedule-api-uri": "/v1/subscription/rateschedule/ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ",
            "autoexpire": 0,
            "soldseparate": 0,
            "ratetermdatecode": "A",
            "ratetermdatedesc": "Adhere to term dates in rate",
            "paymentorder": 1,
            "reportcode": "BASICMEMBERS",
            "activationcode": "I",
            "activationdesc": "First Invoice For Subscription Paid",
            "altactivationcode": "I",
            "altactivationdesc": "First Invoice For Subscription Paid",
            "allowrateglaccountoverride": 0,
            "glaccount_api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
            "glaccountname": "Membership Revenue",
            "frontendcontent": "",
            "frontendcompletedcontent": "",
            "frontendparentsubcontent": ""
        }
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update subscription.",
        ...
    ]
}

DELETE

/v1/subscription/type/{api_id}/subscription/{sub_api_id}

expand

/webhook

GET - Returns webhooks
POST - Creates a webhook
PUT - Updates a webhook
DELETE - Deletes a webhook

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/webhook

expand

Response Details

Each webhook included in the response will have the same data structure as the GET /v1/webhook/{api_id} response.

Sample Request

GET /v1/webhook HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired

Sample Response (success)

200 OK

{
    "data": {
        "count": 2,
        "webhook": [
            {
                "payload-uri": "http://www.mywebhookreceiver.com",
                "sqsqueue": "ABC123",
                "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "x-api-uri": "/v1/webhook/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "event": [
                    "membercreate": {
                        "enabled": true
                    },
                    "memberupdate": {
                        "enabled": true
                    },
                    "membermerge": {
                        "enabled": false
                    },
                    "memberdelete": {
                        "enabled": false
                    },
                    "membergroupchange": {
                        "enabled": true,
                        "group": [
                            {
                                "group": "Public"
                                "groupcode": "Public",
                                "grouppath": "Public",
                                "description": "Visitors that are not logged in",
                                "systemgroup": 1,
                                "alertifpopulated": 0,
                                "manualassignments": 0,
                                "protected": 0,
                                "membercount": 133,
                                "badgebackgroundcolor": "#3b3e66",
                                "badgetextcolor": "#ffffff",
                                "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "x-api-uri": "/v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                                "parentapi_id": "",
                                "x-parent-api-uri": ""
                            },
                            ...
                        ]
                    },
                    "subscriptionstatuschange": {
                        "enabled": false,
                        "status": [
                            {
                            	"status": "Active, Billed",
                            	"subscription": "Type: Membership;"
                            },
                            ...
                        ]
                    }
                ]
            } 
            ...
        ]
    },
    "error":false,
    "messages":[]
}

GET

/v1/webhook/{api_id}

expand

Sample Request

GET /v1/webhook/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 WEBHOOK NOT FOUND	invalid webhook api_id

Sample Response (success)

200 OK

{
    "data": {
        "count": 1,
        "webhook": {
            "payload-uri": "http://www.mywebhookreceiver.com",
            "sqsqueue": "ABC123",
            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "x-api-uri": "/v1/webhook/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "event": [
                "membercreate": {
                    "enabled": true
                },
                "memberupdate": {
                    "enabled": true
                },
                "membermerge": {
                    "enabled": false
                },
                "memberdelete": {
                    "enabled": false
                },
                "membergroupchange": {
                    "enabled": true,
                    "group": [
                        {
                            "group": "Public"
                            "groupcode": "Public",
                            "grouppath": "Public",
                            "description": "Visitors that are not logged in",
                            "systemgroup": 1,
                            "alertifpopulated": 0,
                            "manualassignments": 0,
                            "protected": 0,
                            "membercount": 133,
                            "badgebackgroundcolor": "#3b3e66",
                            "badgetextcolor": "#ffffff",
                            "api_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                            "x-api-uri": "/v1/group/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                            "parentapi_id": "",
                            "x-parent-api-uri": ""
                        },
                        ...
                    ]
                },
                "subscriptionstatuschange": {
                    "enabled": false,
                    "status": [
                        {
                        	"status": "Active, Billed",
                        	"subscription": "Type: Membership;"
                        },
                        ...
                    ]
                }
            ]
        } 
    },
    "error":false,
    "messages":[]
}

Sample Response (failure)

404 WEBHOOK NOT FOUND

{
    "data": {},
    "error": true,
    "messages": [
        "Webhook not found."
    ]
}

POST

/v1/webhook

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. Only the required keys need to be provided.

payload-uri - full payload url of the webhook (required)
event is an object of events to trigger the webhook (optional). Eligible subkeys are:
membercreate,memberupdate,memberdelete,membermerge,membergroupchange,subscriptionstatuschange
membergroupchange supports group_api_id subkey to manage subscribed groups
subscriptionstatuschange supports below subkeys to manage subscribed statuses
type_api_id is an array of subscription type api_id
subscription_api_id is an array of subscription api_id
rate_api_id is an array of subscription rate api_id
status is an array of subscription statuses
activationstatus is the activation status of the subscription

Sample Request

POST /v1/webhook HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 69

{
    "payload-uri": "https://www.mywebhookreceiver.com",
    "event": {
        "membercreate": {
            "enabled": true
        },
        "memberupdate": {
            "enabled": true
        },
        "membermerge": {
            "enabled": true
        },
        "memberdelete": {
            "enabled": false
        },
        "membergroupchange": {
            "enabled": true,
            "group_api_id": ["AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA","BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"]
        },
        "subscriptionstatuschange": {
            "enabled": true,
            "status": [
                {
                    "status": ["Expired","Deleted"]
                },
                {
                    "type_api_id": ["CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC","DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"],
                    "status": ["Renewal Not Sent"]
                },
                {
                    "type_api_id": ["EEEEEEEE-EEEE-EEEE-EEEE-EEEEEEEEEEEE"],
                    "subscription_api_id": ["FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"],
                    "rate_api_id": ["GGGGGGGG-GGGG-GGGG-GGGG-GGGGGGGGGGGG","HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH","JJJJJJJJ-JJJJ-JJJJ-JJJJ-JJJJJJJJJJJJ"],
                    "activationstatus": "Activation Requirement Met",
                    "status": ["Accepted","Active","Billed"]
                }
            ]
        }
    }
}

Possible Response Codes

201 CREATED	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
417 EXPECTATION FAILED	invalid JSON body
500 NOT CREATED	error creating webhook

Sample Response (success)

201 CREATED

{
    "data": {
        "count": 1,
        "webhook": {
            "payload-uri": "https://www.mywebhookreceiver.com",
            "api_id": "WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
            "x-api-uri": "/v1/webhook/WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
            "event": {
                "membercreate": {
                    "enabled": true
                },
                "memberupdate": {
                    "enabled": true
                },
                "membermerge": {
                    "enabled": true
                },
                "memberdelete": {
                    "enabled": false
                },
                "membergroupchange": {
                    "enabled": true,
                    "group": [
                        {
                            "api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
                            "grouppath": "All Members",
                            "x-api-uri": "/v1/group/AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
                            "systemgroup": 0,
                            "badgetextcolor": "#ffffff",
                            "x-parent-api-uri": "",
                            "badgebackgroundcolor": "#3b3e66",
                            "alertifpopulated": 0,
                            "membercount": 239,
                            "manualassignments": 1,
                            "protected": 0,
                            "parentapi_id": "",
                            "groupcode": "",
                            "description": "",
                            "group": "All Members"
                        },
                        {
                            "api_id": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
                            "grouppath": "Former Members",
                            "x-api-uri": "/v1/group/BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
                            "systemgroup": 0,
                            "badgetextcolor": "#ffffff",
                            "x-parent-api-uri": "",
                            "badgebackgroundcolor": "#3b3e66",
                            "alertifpopulated": 0,
                            "membercount": 173,
                            "manualassignments": 0,
                            "protected": 0,
                            "parentapi_id": "",
                            "groupcode": "",
                            "description": "",
                            "group": "Former Members"
                        }
                    ]
                },
                "subscriptionstatuschange": {
                    "enabled": true,
                    "status": [
                        {
                            "status": "Deleted, Expired",
                            "subscription": "Type: All Subscription Types; Activation Status: All Activation Options;"
                        },
                        {
                            "status": "Renewal Not Sent",
                            "subscription": "Type: Sections, Membership; Subscription: All Subscriptions; Activation Status: All Activation Options;"
                        },
                        {
                            "status": "Accepted, Active, Billed",
                            "subscription": "Type: Membership; Subscription: Annual Membership; Rate: Associate, Less than 5 years, Student; Activation Status: Activation Requirement Met;"
                        },
                    ]
                }
            },
            "sqsqueue": ""
        },
        "result": "Webhook created."
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT CREATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to create webhook.",
        ...
    ]
}

PUT

/v1/webhook/{api_id}

expand

Required Request Details

The request must contain a JSON object in the body with the following keys. You only need to provide the keys for data you wish to update.

payload-uri - full payload url of the webhook
event is an object of events to trigger the webhook. Eligible subkeys are:
membercreate,memberupdate,memberdelete,membermerge,membergroupchange,subscriptionstatuschange
membergroupchange supports group_api_id subkey to manage subscribed groups
subscriptionstatuschange supports below subkeys to manage subscribed statuses
type_api_id is an array of subscription type api_id
subscription_api_id is an array of subscription api_id
rate_api_id is an array of subscription rate api_id
status is an array of subscription statuses
activationstatus is the activation status of the subscription

Sample Request

PUT /v1/webhook/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX HTTP/1.1
Content-Type: application/json
Authorization: Bearer YOUR_API_TOKEN
Host: api.membercentral.com
Content-Length: 91

{
    "payload-uri": "https://www.mywebhookreceiver.com",
    "event": {
        "membercreate": {
            "enabled": true
        },
        "memberupdate": {
            "enabled": true
        },
        "membermerge": {
            "enabled": true
        },
        "memberdelete": {
            "enabled": false
        },
        "membergroupchange": {
            "enabled": true,
            "group_api_id": ["AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA","BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB"]
        },
        "subscriptionstatuschange": {
            "enabled": true,
            "status": [
                {
                    "status": ["Expired","Deleted"]
                },
                {
                    "type_api_id": ["CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC","DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD"],
                    "status": ["Renewal Not Sent"]
                },
                {
                    "type_api_id": ["EEEEEEEE-EEEE-EEEE-EEEE-EEEEEEEEEEEE"],
                    "subscription_api_id": ["FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF"],
                    "rate_api_id": ["GGGGGGGG-GGGG-GGGG-GGGG-GGGGGGGGGGGG","HHHHHHHH-HHHH-HHHH-HHHH-HHHHHHHHHHHH","JJJJJJJJ-JJJJ-JJJJ-JJJJ-JJJJJJJJJJJJ"],
                    "activationstatus": "Activation Requirement Met",
                    "status": ["Accepted","Active","Billed"]
                }
            ]
        }
    }
}

Possible Response Codes

200 OK	success
401 INVALID TOKEN	invalid authorization token
403 EXPIRED TOKEN	authorization token expired
404 WEBHOOK NOT FOUND	webhook not found
417 EXPECTATION FAILED	invalid JSON body
500 NOT UPDATED	unable to update webhook

Sample Response (success)

200 OK

{
    "data": {
        "count": 1,
        "webhook": {
            "payload-uri": "https://www.mywebhookreceiver.com",
            "api_id": "WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
            "x-api-uri": "/v1/webhook/WWWWWWWW-WWWW-WWWW-WWWW-WWWWWWWWWWWW",
            "event": {
                "membercreate": {
                    "enabled": true
                },
                "memberupdate": {
                    "enabled": true
                },
                "membermerge": {
                    "enabled": true
                },
                "memberdelete": {
                    "enabled": false
                },
                "membergroupchange": {
                    "enabled": true,
                    "group": [
                        {
                            "api_id": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
                            "grouppath": "All Members",
                            "x-api-uri": "/v1/group/AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA",
                            "systemgroup": 0,
                            "badgetextcolor": "#ffffff",
                            "x-parent-api-uri": "",
                            "badgebackgroundcolor": "#3b3e66",
                            "alertifpopulated": 0,
                            "membercount": 239,
                            "manualassignments": 1,
                            "protected": 0,
                            "parentapi_id": "",
                            "groupcode": "",
                            "description": "",
                            "group": "All Members"
                        },
                        {
                            "api_id": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
                            "grouppath": "Former Members",
                            "x-api-uri": "/v1/group/BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB",
                            "systemgroup": 0,
                            "badgetextcolor": "#ffffff",
                            "x-parent-api-uri": "",
                            "badgebackgroundcolor": "#3b3e66",
                            "alertifpopulated": 0,
                            "membercount": 173,
                            "manualassignments": 0,
                            "protected": 0,
                            "parentapi_id": "",
                            "groupcode": "",
                            "description": "",
                            "group": "Former Members"
                        }
                    ]
                },
                "subscriptionstatuschange": {
                    "enabled": true,
                    "status": [
                        {
                            "status": "Deleted, Expired",
                            "subscription": "Type: All Subscription Types; Activation Status: All Activation Options;"
                        },
                        {
                            "status": "Renewal Not Sent",
                            "subscription": "Type: Sections, Membership; Subscription: All Subscriptions; Activation Status: All Activation Options;"
                        },
                        {
                            "status": "Accepted, Active, Billed",
                            "subscription": "Type: Membership; Subscription: Annual Membership; Rate: Associate, Less than 5 years, Student; Activation Status: Activation Requirement Met;"
                        },
                    ]
                }
            },
            "sqsqueue": ""
        },
        "result": "Webhook updated."
    },
    "error": false,
    "messages": []
}

Sample Response (failure)

500 NOT UPDATED

{
    "data": {},
    "error": true,
    "messages": [
        "Unable to update webhook.",
        ...
    ]
}

DELETE

/v1/webhook/{api_id}

expand

/website

GET - Returns website types
POST - Creates a website type
PUT - Updates a website type
DELETE - Deletes a website type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET

/v1/website

expand

GET

/v1/website/{api_id}

expand

POST

/v1/website

expand

PUT

/v1/website/{api_id}

expand

DELETE

/v1/website/{api_id}

expand

200 OK	success
401 UNAUTHORIZED	invalid keys
417 EXPECTATION FAILED	missing or invalid JSON body