Wolfeo Developers

# Custom Fields

NOTE

The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.

# List Custom Fields

GET https://api.wolfeo.me/v1/custom-fields

Returns all custom field definitions for your account.

# Example Request

curl --request GET "https://api.wolfeo.me/v1/custom-fields" \
  --header "Authorization: Bearer YOUR_API_KEY"

# Sample Return

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "Company",
            "type": "text",
            "values": null
        },
        {
            "id": 2,
            "name": "Plan",
            "type": "select",
            "values": "Starter,Pro,Elite"
        }
    ]
}

TIP

values is only populated for select type fields — it contains a comma-separated list of allowed options.

# Set Contact Custom Field

PUT https://api.wolfeo.me/v1/contact-custom-field

Sets (or updates) a custom field value for a contact. Creates the value if it doesn't exist yet.

# Example Request

curl --request PUT "https://api.wolfeo.me/v1/contact-custom-field" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"contact_id": 1, "custom_field_id": 1, "value": "Wolfeo Ltd"}'

# Parameters

Parameter Type Description
email** string Contact's email address
contact_id** integer Contact's ID
custom_field_id* integer The custom field ID to set
value* string The value to store (max 1000 characters)

** at least one of these parameters must be passed — * denotes required

# Sample Return

{
    "success": true,
    "data": {
        "contact_id": 1,
        "custom_field_id": 1,
        "value": "Wolfeo Ltd"
    }
}

# Possible Errors

Code HTTP Description
NOT_FOUND 404 Contact or custom field not found

# What's next

  • Contacts — manage contacts, tags, and sequences

← Financials →