Create Designation

Create a new Designation record.

Optional fields

Any request field marked nullable in the schema may be omitted from the payload entirely - you don't need to send it as null. On a PATCH (partial update), an omitted field is left unchanged; on a POST it's left unset.

HTTP Request

POST/users/api/v1/designations/

Example Response

{
  "id": 0,
  "site": 0,
  "created": "2026-09-08T14:40:49.000Z",
  "modified": "2026-09-08T14:40:49.000Z",
  "source_ref": "string",
  "designation": "string"
}

NameDescription

id

integer

ID

site

integer

Site

created

string

Created

modified

string

Modified

source_ref

nullable

string<= 100 characters

Source ref - A unique reference to use for linking records back to *your* system. NB: This must be unique across the entire Prop Data system, so it's best to use a consistent prefix unique to your integration to avoid conflicts with other api consumers.

designation

required

string[ 1...50 ] characters

Designation

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active