Create Additional Field

POST

https://api.plusvibe.ai/api/v1/workspaces/additional-fields

Creates a new additional field on the workspace.

Required Fields:

workspace_id: Workspace ID

name: Display name for the field

Optional:

default_value: Default value for the field

Field names are normalized on creation: lowercased, with spaces and special characters replaced by underscores (e.g. Renewal Date becomes renewal_date). The normalized name is what the List endpoint returns and what Update/Delete expect.

The name must be unique within the workspace: it may not match a standard lead field (e.g. email, first_name), an existing additional field, or a custom variable already used by one of the workspace's campaigns.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Operation completed successfully.

Bodyapplication/json

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

cURL

Field with a default valueField without a default value

curl --location 'https://api.plusvibe.ai/api/v1/workspaces/additional-fields' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "workspace_id": "65099a0dd96fae8ab61130c0",
    "name": "Industry",
    "default_value": "SaaS"
}'

Response Example

200 - Success Example

{
    "status": "success"
}

Modified at 2026-07-28 08:30:20

List Additional Fields

Update Additional Field Default Value