Skip to content
API Reference/
/
Create a Person

Create a Person

Request

Create a person. It can be added to a content list later

Security
X-API-KEY or Authorization
Bodyapplication/jsonrequired

Person object that needs to be created

titlestringrequired

The person's title: e.g. 'Store manager'

descriptionstring

Description for the person: e.g. 'Responsible for the day-to-day operations of the store'

identifierstring

Unique Identifier for the Person

listNamestring

Name of the section this person belongs to

idinteger, (int64)

The uberall unique id for the person

namestringrequired

The person's full name

imageobject

Image of the person (use the Image object format)

urlstring

A valid url of a page with more details about the person

curl -i -X POST \
  https://uberall.com/api/persons \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "description": "string",
    "identifier": "string",
    "listName": "string",
    "id": 0,
    "name": "string",
    "image": {
      "id": 0,
      "url": "string",
      "type": "LOGO",
      "description": "string",
      "uid": "string"
    },
    "url": "string"
  }'

Responses

Person created

Bodyapplication/json
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "person": { … }
  }
}