# Contacts

NOTE

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

# Retrieve Contact

GET https://api.wolfeo.me/contact

# Example Request

curl --request GET "https://api.wolfeo.me/contact?api_key=demokey&contact_id=1"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
email** string A contact's email address
contact_id** int A contact's ID

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

# Sample Return

{
    "email": "john@ted.com",
    "first_name": "John",
    "last_name": "Doe",
    "email_marketing": false,
    "GDPR": false,
    "tags": [
        "59"
    ],
    "sequences": [
        "61",
        "70",
        "72",
        "41"
    ]
}

# Create Contact

POST https://api.wolfeo.me/contact

# Example Request

curl --request POST "https://api.wolfeo.me/contact?api_key=demokey&email=john@doe.ie"

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
first_name string Contacts first name
last_name string Contacts last/second name
email* string Contacts email address
email_marketing boolean Boolean value for email marketing
gdpr boolean Boolean value for GDPR permissions
tag_ids string String list of tag IDs for the contact to be added to. For example, 123,53434,2503
sequence_ids string String list of sequence IDs for the contact to be added to. For example, 123,53434,2503

* denotes a required parameter

# Sample Return

{
    "success": true,
    "data": {
        "contact_id": 79
    }
}

# Update Contact

PUT https://api.wolfeo.me/contact

# Example Request

curl --request PUT "https://api.wolfeo.me/contact?api_key=demokey&contact_id=1&first_name=John"

Any values passed will be updated.

# Parameters

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
first_name string Contacts first name
last_name string Contacts last/second name
email** string A contact's email address
contact_id** int A contact's ID
email_marketing boolean Boolean value for email marketing
gdpr boolean Boolean value for GDPR permissions
tag_ids string String list of tag IDs for the contact to be added to. For example, 123,53434,2503
sequence_ids string String list of sequence IDs for the contact to be added to. For example, 123,53434,2503

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

# Sample Return

{
    "success": true,
    "data": {
        "contact_id": 79
    }
}

# Retrieve count of new contacts based on given date range

GET https://api.wolfeo.me/contact-count

# Example Request

curl --request GET "https://api.wolfeo.me/contact-count?api_key=demo_key&period=all"

# Parameters

GET

Parameter Type Description
api_key* string Your secret Wolfeo API key, required for all API calls
period* string Option for filtering contacts, required
range string Date range of contact created

* denotes a required parameter

# Possible values for "period"

today, yesterday, last7days, last30days, between

# Example value for "range"

2023-06-01to2023-06-29

# Example url

for all

https://api.wolfeo.me/contact-count?api_key=demo_key&period=all

for today

https://api.wolfeo.me/contact-count?api_key=demo_key&period=today

for yesterday

https://api.wolfeo.me/contact-count?api_key=demo_key&period=yesterday

for last7days

https://api.wolfeo.me/contact-count?api_key=demo_key&period=last7days

for last30days

https://api.wolfeo.me/contact-count?api_key=demo_key&period=last30days

for between

https://api.wolfeo.me/contact-count?api_key=demo_key&period=between&range=2023-06-01to2023-06-29

# Sample Return

{
    "count": 906
}

← Tags →