Link Search Menu Expand Document

Updated Fri Jun 18th 2021, 16:17 UTC

Create a User Schema field

POST /:account/user_schema

Note: This endpoint is still under active development, and may change without warning.

User Schema fields allow primary account admins to designate fields that users can fill out to customize their personalization variables.

Examples

Creating a custom field

Request

POST /textus/user_schema

Body

{
   "type": "url",
   "title": "Calendar Link",
   "description": "Your personal calend.ly url."
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /textus/user_schema
     -d '{json: "body"}' 

Response

Status

201

Response Type

CustomField

Example
{
  "@type": "CustomField",
  "@context": "/contexts/CustomField.jsonld",
  "id": "/textus/user_schema/qlrDLk",
  "slug": "calendar-link",
  "title": "Calendar Link",
  "type": "url",
  "description": "Your personal calend.ly url.",
  "createdAt": "2020-10-15T20:07:20.862Z",
  "inUse": false
}

© 2021 TextUs