Persons

Create a person

Creates a person at the location. Send an externalReference, your own id for the person, to make the call safe to repeat. When a person at the location already has that reference, that person is returned unchanged with 200 and nothing is created. A person with an identity number that another person at the location already has, with the same type, is normally refused with duplicate.

post/v1/locations/{locationId}/persons

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/persons
  • Auth: HTTP bearer

Path parameters

locationIdstring required

Headers

Idempotency-Keystring

A value you make up for this one request, such as a UUID. Send the same value when you retry and the first answer is returned; see Retrying safely.

Request body

dateOfBirthstring

ISO 8601 date.

emailstring
externalReferencestring

Your own id for it, at most 100 characters, such as its id in your system. It makes the create safe to repeat and lets you find it again. Compared exactly, letter case included.

gender'male' | 'female' | 'other'
namestring required
notesstring

Staff-facing notes, at most 1000 characters.

onlineBookingBlockedboolean

Set to true to stop the person booking online.

otherPhoneNumberstring
phoneNumberstring

Mobile number in E.164 format: a plus sign, the country code and the number, at most 15 digits.

Example request

{
  "address": {
    "city": "Stockholm",
    "country": "SE",
    "line1": "Storgatan 12",
    "line2": "Lgh 1102",
    "postCode": "111 51"
  },
  "dateOfBirth": "1986-04-12",
  "email": "anna.lindqvist@example.com",
  "externalReference": "crm-88121",
  "identityNumber": {
    "number": "198604122385",
    "type": "se_personnummer"
  },
  "name": "Anna Lindqvist",
  "otherPhoneNumber": "+4686543210",
  "phoneNumber": "+46701234567"
}

Response

A person with this externalReference already existed.

createdAtstring date-time
dateOfBirthstring

ISO 8601 date.

emailstring
externalReferencestring

Your own id for it, as sent when it was created.

genderstring

One lower-case word such as female. More values may be added.

idstring required
locationIdstring required
namestring
notesstring

Staff-facing notes, at most 1000 characters.

onlineBookingBlockedboolean required

True when the person may not book online.

otherPhoneNumberstring
phoneNumberstring

Mobile number, in E.164 format when it was set through this API.

updatedAtstring date-time

Example response

{
  "address": {
    "city": "Stockholm",
    "country": "SE",
    "line1": "Storgatan 12",
    "line2": "Lgh 1102",
    "postCode": "111 51"
  },
  "dateOfBirth": "1986-04-12",
  "email": "anna.lindqvist@example.com",
  "externalReference": "crm-88121",
  "gender": "female",
  "id": "per_2QCtWVSaVO7yCRYBj1zsbA",
  "identityNumber": {
    "number": "198604122385",
    "type": "se_personnummer"
  },
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "name": "Anna Lindqvist",
  "otherPhoneNumber": "+4686543210",
  "owner": {
    "resourceId": "res_2QCtWVSaVO7yCRYBj1zsbA"
  },
  "phoneNumber": "+46701234567"
}

Changes

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