people

Update a person

Change one person by id: the same fields as the endpoint above, all optional, with null to clear one. The address itself cannot be changed, so a person's evidence trail stays attached to the address it was collected under. Sending status: "archived" is how an offboarding workflow takes somebody out of the programme.

patch/people/{id}

Request

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

Path parameters

idstring required

The id of the row.

Example:r_2f8c

Request body

emailstring

The address this person already has. It cannot be changed here.

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

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

Changes

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