API referenceCustom Fields
Restore an archived custom field
POST
apiKey writeheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: write
id*stringFormat
uuididempotency-key?stringRun this write once: a retry with the same key gets the first answer (24 hours).
Length
1 <= length <= 255OK
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 POST 'https://api.postforge.dev/v1/custom-fields/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore'{ "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"}Archive a custom field POST
Hides the field and stops every writer, a store’s too: writes to it are refused and recorded. Its values stay until it’s deleted.
List a profile’s consent changes GET
Every change of the person’s marketing consent, newest first, with its source and proof. The latest change per channel is the person’s consent.