Skip to main content
POST
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
personalize
Personalize a collection
curl --request POST \
  --url https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/personalize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companyId": "<string>",
  "sourceFields": {
    "firstName": "<string>",
    "lastName": "<string>",
    "department": "<string>",
    "location": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "birthDate": "2023-11-07T05:31:56Z"
  }
}'
{
  "sha": "<string>",
  "fields": {
    "name": {
      "first": "<string>",
      "last": "<string>",
      "firstNameInitials": "<string>",
      "lastNameInitials": "<string>",
      "initials": "<string>",
      "firstPossessive": "<string>"
    },
    "anniversary": {
      "month": 123,
      "monthPadded": "<string>",
      "year": 123,
      "decade": "<string>",
      "years": 123,
      "yearsPadded": "<string>",
      "hundreds": "<string>",
      "zodiac": "Capricorn",
      "ordinal": "<string>",
      "elapsed": "<string>",
      "elapsedYears": "<string>"
    },
    "birth": {
      "month": 123,
      "monthPadded": "<string>",
      "year": 123,
      "decade": "<string>",
      "years": 123,
      "yearsPadded": "<string>",
      "hundreds": "<string>",
      "zodiac": "Capricorn",
      "ordinal": "<string>",
      "elapsed": "<string>",
      "elapsedYears": "<string>"
    },
    "work": {
      "department": "<string>",
      "location": "<string>"
    }
  },
  "status": "Pending"
}
The personalization takes around 15-20 seconds and only works on personalizable collections. The response will return:

Authorizations

​
Authorization
string
header
required

Path Parameters

​
collectionId
string
required

Body

application/json
​
companyId
string
required
​
sourceFields
object
required

Response

​
sha
string
required
​
fields
object
required
​
status
enum<string>
required
Available options:
Pending,
Done,
Error