Custom fields

Create a custom field

A field every post can carry, such as a campaign. Its key and type cannot change, and a key is used once per team (409 otherwise).

post/fields

Request

  • Base URL
    https://api.rizamo.com/v1
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

1 to 255 printable characters, new for each request (a UUID); the body up to 1 MB. For 24 hours a repeat with the same key, path and body gets the first answer, with Idempotent-Replayed: true, instead of running again; 5xx, 409 and 429 answers are not kept. Errors, Retries, has the rest.

Request body

keystring required

Lowercase letters, digits and underscores, starting with a letter. It cannot change.

entity'post'

What the field is on: post, the only kind today.

labelstring required

Its name for people, up to 60 characters: "Campaign".

type'text' | 'select' | 'multi_select' | 'number' | 'url' | 'date' | 'checkbox' required

text, select, multi_select, number, url, date or checkbox. It cannot change.

optionsstring[]

The choices of a select or multi_select field. Required for those, refused for the others.

descriptionstring

What the field is for, up to 200 characters, shown to people and agents.

Response

OK

keystring required
entity'post' required
labelstring required
type'text' | 'select' | 'multi_select' | 'number' | 'url' | 'date' | 'checkbox' required
optionsstring[]
descriptionstring

Changes

No recorded changes to this operation across all 1 revision of this API.