API referenceCustom Fields
Get a custom field
GET
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidOK
application/json- response
id*stringFormat
uuidkey*stringlabel*stringdescription*string|nulltype*stringValue in
"text""number""boolean""date""list""json"platform*string|nullprofilesCount*integerarchivedAt*|Format
date-timecreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timecurl -X GET 'https://api.postforge.dev/v1/custom-fields/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "label": "string", "description": "string", "type": "text", "platform": "string", "profilesCount": 0, "archivedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}Create a custom field POST
Declares a field with its type. The key is made from the label when it isn’t given, and never changes after (emails and the API use it). A write to a key that doesn’t exist yet (the API, an automation, a store) declares a field too, with the type of its first value. 409 `custom_field_exists` when the key is taken; 422 `too_many_custom_fields` past 1,000.
Update a custom field PATCH
Changes the label or description. The key stays as it was made (emails and the API use it); changing the type is a conversion.