Create Workspace Property
Create a custom property for the workspace associated with your API key.
Endpoint
POST https://api.campaignlark.com/v1/workspace/properties
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
label | string | required | Human-readable property label (1–64 characters). |
merge_tag | string | required | Property merge tag (1–96 characters). |
value | string | optional | Initial property value (up to 512 characters). |
Sample Request
POST https://api.campaignlark.com/v1/workspace/properties
Content-Type: application/json
{
"label": "Industry",
"merge_tag": "industry",
"value": "Technology"
}
Response
Success — 201 Created
{
"error": null,
"data": {
"id": 12,
"label": "Industry",
"merge_tag": "industry",
"value": "Technology"
}
}
Property Object
| Field | Type | Description |
|---|---|---|
id | integer | Unique property ID. |
label | string | Human-readable property label. |
merge_tag | string | Property merge tag used in messages. |
value | string | Current property value. |