Versions Compared

Version Old Version 1 New Version Current
Changes made by

Danny Hannah

Danny Hannah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Authentication

Convertr uses OAuth for its API authentication. All end points (unless explicitly detailed) require an access_token to be passed through in a header with each request. Tokens expire after 60minutes and need to either be refreshed or a new one generated.

Note

Beware that if your password is expired you will still receive an access token, but will receive the following error on any other API requests.

You can see the status password_expired property which is returned along with your access token - if it’s true then you will need to reset your password.

Requesting a token

Request:

Code Block
POST /api/login HTTP/1.1
Host: {enterprise}.cvtr.io
Content-Type: application/x-www-form-urlencoded

username={your_email}&
password={your_password}

...

Code Block
languagejs
{
    "type": "https://tools.ietf.org/html/rfc2616#section-10",
    "title": "An error occurred",
    "detail": "Password expired"
}

Getting and Adding Contact Responses

Now you have an access token, you can start logging contact responses against leads.
To do this you will need the Convertr Lead ID.

...