API Key is a part of an API Key and Integrations add-on, click here to learn how to get it on Marketplace »


Woodpecker API responses with various type of answers

  • 200 OK
    If everything is ok, you should get "200 OK" response.
    As additional information that helps download data, we provide a X-Total-Count information in the header. This field shows the number of all records that meet the requested criteria.

  • 204 No Content
    If Woodpecker API returns an empty dataset, you will receive "204 No Content" response.

  • 400 Bad Request

    When something went wrong. Woodpecker will provide additional information about an error in a form similar to the one described below.

Error code

Error description

E_URL_NOT_FOUND

When you try to access Woodpecker API endpoint that does not exist.

E_SESSION

The API key you've entered is incorrect or no longer valid. Check if you entered the key correctly.
You can generate a new key in Woodpecker: Settings -> API Keys.

E_RECORD_NOT_FOUND

A campaign you want to add prospects to cannot be found.

E_TOO_MANY_REQUESTS

Too many requests simultaneously. Woodpecker allows only 2 concurrent connections to the API at the same time.

E_REQUIRED_ELEMENT

Element Prospects are required.

E_INV_STATUS

Your prospect's status is other than ACTIVE. Woodpecker API does not allow prospects with a status other than active. That prevents sending a message to prospects who shouldn't be touched or their status is unknown.

E_DUPLICATE

Duplicate. The prospect has been added to your prospect base before.

E_EMAIL

Emails could not be added or look like invalid email format.

E_EMAIL_NOT_EXISTS

Looks like this email doesn't exist.

E_WRONG_PARAM

Invalid request / Invalid target_url

Did this answer your question?