API Documentation - Profiles

Profiles Instance Resources

Method	Endpoint	Description
GET	/api/v1/accounts/{account_id}/profiles	Get a paginated list of details for all profiles.
GET	/api/v1/accounts/{account_id}/profiles/{profile_id}	Get details about a single profile.
POST	/api/v1/accounts/{account_id}/profiles	Create a new profile.
POST	/api/v1/accounts/{account_id}/profiles/{profile_id}	Edit details for a single profile.
DELETE	/api/v1/accounts/{account_id}/profiles/{profile_id}	Delete a single profile.

Get All Profiles

Get a paginated list of details for all profiles.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/accounts/{account_id}/profiles

Supported Parameters

Parameter	Type	Description	Required
`profiles_per_page`	number	Number of profiles to return for this request (default 25, maximum 250).	No
`page_number`	number	Page number to return for this request.	No
`start_date`	string	Start date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`.	No
`end_date`	string	End date for this request in date or date/time ISO 8601 format (UTC); `2015-11-10` or `2015-11-10T00:00:00Z`.	No
`order`	string	Order in which to return the profiles by date created; `asc` or (default) `desc`.	No

Response Details

Parameter	Type	Description
`profiles_per_page`	number	The number of profiles returned in the request.
`page_number`	number	The current page number in the request.
`total_pages`	number	The total amount of pages available in the request.
`total_profiles`	number	The total amount of profiles available in the request.
`profiles`	array	Contains all the requested profiles.
`profile_id`	number	Unique identifier for the profile.
`profile_name`	string	The name of the profile.
`date_created`	string	Date and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "page_number": 1,
      "profiles_per_page": 25,
      "total_pages": 2,
      "total_profiles": 45,
      "profiles": [
        {
          "profile_id": 2548713,
          "profile_name": "WhatConverts Tracking",
          "date_created": "2016-06-24T17:24:42Z"
        },
        ...
      ]
    }

Get Single Profile

Get details for specific profile.

Resource Details

Method	Endpoint
GET	https://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

No supported parameters.

Response Details

Includes all response details from get all profiles resource.

Create New Profile

Create a new profile.

Resource Details

Method	Endpoint
POST	https://app.whatconverts.com/api/v1/accounts/{account_id}/profiles

Supported Parameters

Parameter	Type	Description	Required
`profile_name`	string	The name for this profile	Yes

Response Details

Parameter	Type	Description
`profile_id`	number	Unique identifier for the profile.
`profile_name`	string	The name of the profile.
`date_created`	string	Date and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "profile_id": 2548713,
      "profile_name": "WhatConverts Tracking",
      "date_created": "2016-06-24T17:24:42Z"
    }

Edit Profile

Edit details for a single profile.

Resource Details

Method	Endpoint
POST	https://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

Parameter	Type	Description	Required
`profile_name`	string	The name for this profile	Yes

Response Details

Parameter	Type	Description
`profile_id`	number	Unique identifier for the profile.
`profile_name`	string	The name of the profile.
`date_created`	string	Date and time when the profile was created in ISO 8601 format (UTC).

Example Response

    {
      "profile_id": 2548713,
      "profile_name": "WhatConverts Tracking",
      "date_created": "2016-06-24T17:24:42Z"
    }

Delete Profile

Delete a single profile.

Notice This will remove all numbers, leads and other settings associated with this profile.

Resource Details

Method	Endpoint
DELETE	https://app.whatconverts.com/api/v1/accounts/{account_id}/profiles/{profile_id}

Supported Parameters

No supported parameters.

Response Details

Parameter	Type	Description
`profile_id`	number	Unique identifier for the profile.

Example Response

    {
      "profile_id": 2548713
    }

Get a FREE presentation of WhatConverts

One of our marketing experts will give you a full presentation of how WhatConverts can help you grow your business.

Schedule a Demo

Whatconverts Features for your Business

Lead Tracking

HIPAA Compliant Form Tracking

Keep ePHI info secure and only give access to people who are authorized to view it.

Lead Tracking

Append Marketing Data to Orders (WordPress)

See which marketing source, campaign or keyword is responsible for online orders.

Lead Tracking

Instant Phone Number Setup & Tracking

Select a tracking number, provide the destination number, and start tracking calls.

Lead Management

Export All Data

Download or send your entire data set with one click.

Profiles Instance Resources

Get All Profiles

Resource Details

Supported Parameters

Response Details

Example Response

Get Single Profile

Resource Details

Supported Parameters

Response Details

Create New Profile

Resource Details

Supported Parameters

Response Details

Example Response

Edit Profile

Resource Details

Supported Parameters

Response Details

Example Response

Delete Profile

Resource Details

Supported Parameters

Response Details

Example Response

Get a FREE presentation of WhatConverts

Grow your business with WhatConverts