Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Update a User Schema field

PUT /:account/user_schema/{id}

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

Updating a User Schema field

Request

PUT /textus/user_schema/calendar

Body

{
  "title": "New title",
  "description": "My new URL description"
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /textus/user_schema/calendar
     -d '{json: "body"}' 

Response

Status

200

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