people

Add or update a person

Create a person, or update the one that already has this address. Safe to call more than once with the same address, which is what makes it usable from an onboarding workflow that may retry.

post/people

Request

  • Base URL: https://api.fallax.io/v1
  • URL: https://api.fallax.io/v1/people
  • Auth: HTTP bearer

Request body

emailstring required

Required. The person's address.

firstNamestring nullable

Optional.

lastNamestring nullable

Optional.

departmentstring nullable

Optional. Reporting and breakdowns group on this.

positionstring nullable

Optional. Job title.

localestring nullable

Optional BCP 47 tag, e.g. nl-BE. Decides which translation of a lure they are sent.

timezonestring nullable

Optional IANA zone, e.g. Europe/Brussels. Decides what local time they are sent at.

status'active' | 'excluded' | 'archived'

active, excluded (stays in the directory, never simulated, not billed) or archived (offboarded).

Example request

{
  "email": "sam@acme.com",
  "locale": "nl-BE",
  "timezone": "Europe/Brussels"
}

Response

Add or update a person

idstring required
emailstring required
firstNamestring nullable required
lastNamestring nullable required
departmentstring nullable required
positionstring nullable required
localestring nullable required
timezonestring nullable required
status'active' | 'excluded' | 'archived' required
syncedProviderstring nullable required
createdAtstring date-time nullable required
createdboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.