Submit Census Sync | Vitable Docs

curl -X POST https://api.vitablehealth.com/v1/employers/empr_abc123def456/census-sync \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "employees": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "date_of_birth": "1990-05-15",
      "email": "jane.doe@acme.com",
      "reference_id": "EMP-001",
      "phone": "4155550100",
      "address": {
        "address_line_1": "123 Main Street",
        "city": "San Francisco",
        "state": "CA",
        "zipcode": "94102",
        "address_line_2": "Apt 4B"
      },
      "start_date": "2024-01-15",
      "employee_class": "Full Time",
      "compensation_type": "Salary"
    },
    {
      "first_name": "John",
      "last_name": "Smith",
      "date_of_birth": "1985-11-20",
      "email": "john.smith@acme.com",
      "phone": "4155550101",
      "start_date": "2024-03-01",
      "employee_class": "Part Time",
      "compensation_type": "Hourly"
    }
  ]
}'

Submits a census sync payload for the specified employer. The employees in the payload will be queued for processing. Returns an accepted response with the timestamp of acceptance.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

employer_idstringRequired

Unique employer identifier (empr_*)

Request

This endpoint expects an object.

employeeslist of objectsRequired

Response headers

X-RateLimit-Limitinteger

Maximum number of requests allowed within the rate limit window

X-RateLimit-Remaininginteger

Number of requests remaining in the current rate limit window

X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

dataobject

The census sync request, including its current processing status.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error