/subscribers

post

https://api.plansource.com/admin/v2/subscribers

Create subscriber resources.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

is_custom_id

boolean

Defaults to false

Set to true if the {id} in the path is customer generated.

Body Params

subscriber_code

string

first_name

string

last_name

string

middle_name

string

address_1

string

address_2

string

city

string

state

string

Valid values are based on what is retrieved from meta resource.

zip_code

string

country

string

Valid values are based on what is retrieved from meta resource.

home_phone

string

work_phone

string

cell_phone

string

gender

string

Valid values are based on what is retrieved from meta resource.

hire_date

string

YYYY-MM-DD date format.

birthdate

string

YYYY-MM-DD date format.

ssn

string

original_effective_date

string

YYYY-MM-DD date format.

change_effective_date

string

YYYY-MM-DD date format.

termination_date

string

YYYY-MM-DD date format.

union_code

string

employment_level

string

Valid values are based on what is retrieved from meta resource.

pay_rate

string

pay_type

string

org_payroll_id

string

Valid values are based on what is retrieved from meta resource.

employee_number

string

public_id

string

marital_status

string

Valid values are based on what is retrieved from meta resource.

division

string

location

string

org_class

string

business_title

string

udef_1

string

udef_2

string

udef_3

string

udef_4

string

udef_5

string

udef_6

string

udef_7

string

udef_8

string

udef_9

string

udef_10

string

udef_11

string

udef_12

string

udef_13

string

udef_14

string

udef_15

string

udef_16

string

udef_17

string

udef_18

string

udef_19

string

udef_20

string

ee_code

string

benefit_company

string

original_hire_date

string

YYYY-MM-DD date format.

seniority_date

string

YYYY-MM-DD date format.

employment_status

string

employment_status_starts_on

string

employment_status_ends_on

string

employee_type

string

current_salary_effective_on

string

YYYY-MM-DD date format.

current_salary

string

benefit_deduction_group

string

highly_compensated

boolean

vip

boolean

fmla

boolean

name_suffix

string

subscriber_status_id

string

status_changed_at

string

YYYY-MM-DD date format.

status_starts_on

string

YYYY-MM-DD date format.

status_ends_on

string

YYYY-MM-DD date format.

benefits_start_date

string

YYYY-MM-DD date format.

benefits_end_date

string

YYYY-MM-DD date format.

parent_dependent_id

string

status_ends_on_expected

string

YYYY-MM-DD date format.

subscriber_status_subtype_id

string

test_employee

boolean

is_voluntary_termination

boolean

hide_from_payroll

boolean

termination_reason_id

string

bank_account_type

string

ssn_exported

boolean

eligible_org_population_ids

string

shareholder

boolean

owner

boolean

anthem_hcid

string

anthem_member_code

string

written_language

string

Valid values are based on what is retrieved from meta resource.

spoken_language

string

Valid values are based on what is retrieved from meta resource.

exclude_from_batch_import

boolean

anthem_sub_id

string

hours_per_week

string

medicare_reason

string

Valid values are based on what is retrieved from meta resource.

medicare_plan

string

Valid values are based on what is retrieved from meta resource.

medicare_effective_date

string

YYYY-MM-DD date format.

medicare_termination_date

string

YYYY-MM-DD date format.

is_smoker

string

Valid values are based on what is retrieved from meta resource.

anthem_emp_dept_code

string

Valid values are based on what is retrieved from meta resource.

county

string

udef_21

string

udef_22

string

udef_23

string

udef_24

string

udef_25

string

udef_26

string

udef_27

string

udef_28

string

udef_29

string

udef_30

string

user_name

string

email2

string

locked_at

string

attempted_logon_count

string

disabled_on

string

preferred_locale

string

Responses

200Multiple subscriber create response.

400Malformed request.

401Invalid token.

403Access error.

404Resource not found.

500InternalServerError