CTM API

https://postman.calltrackingmetrics.com/
Admin
The CTM API provides programmatic access to CallTrackingMetrics features, enabling developers to...
Tokens:1,653
Snippets:17
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Basic Authentication Header Example

Source: https://postman.calltrackingmetrics.com/

Shows the structure of an HTTP request using Basic Authentication with an Authorization header.

```http
GET /api/v1/accounts.json HTTP/1.1
Host: api.calltrackingmetrics.com
Authorization: Basic ABC123....
```

--------------------------------

### POST /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks

Source: https://postman.calltrackingmetrics.com/

Adds a new task to a lead reactor.

```APIDOC
## POST /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks

### Description
Creates a new task associated with a specific lead reactor.

### Method
POST

### Endpoint
https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The unique identifier for the account.
- **lead_reactor_id** (string) - Required - The unique identifier for the lead reactor.

#### Request Body
- **contact_id** (string) - Optional - The contact ID.
- **phone_number** (string) - Required - The phone number to contact.
- **name** (string) - Optional - Name of the task.
- **reason** (string) - Optional - Reason for the call.
- **position** (integer) - Optional - Task position.
- **status** (string) - Optional - Task status (e.g., pending).
- **fields** (object) - Optional - Custom fields.
```

--------------------------------

### Add Task via cURL

Source: https://postman.calltrackingmetrics.com/

Creates a new task for a lead reactor using a POST request with a JSON body.

```bash
curl --location -g 'https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks' \
--data '{
    "contact_id": "optional contact id",
    "phone_number": "required phone number to contact",
    "name": "name of task can be name of contact or goal of task",
    "reason": "optional reason for call",
    "position": 5,
    "status": "pending",
    "fields": {"your_custom_field": "value"},

}'
```

--------------------------------

### PATCH /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

Source: https://postman.calltrackingmetrics.com/

Updates an existing lead reactor.

```APIDOC
## PATCH /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

### Description
Updates an existing lead reactor identified by the account and reactor IDs.

### Method
PATCH

### Endpoint
https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The unique identifier for the account.
- **lead_reactor_id** (string) - Required - The unique identifier for the lead reactor.
```

--------------------------------

### PATCH /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

Source: https://postman.calltrackingmetrics.com/

Updates an existing task.

```APIDOC
## PATCH /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

### Description
Updates an existing task associated with a lead reactor.

### Method
PATCH

### Endpoint
https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The unique identifier for the account.
- **lead_reactor_id** (string) - Required - The unique identifier for the lead reactor.
- **task_id** (string) - Required - The unique identifier for the task.
```

--------------------------------

### Update Lead Reactor via cURL

Source: https://postman.calltrackingmetrics.com/

Updates a lead reactor resource using a PATCH request.

```bash
curl --location -g --request PATCH 'https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}'
```

--------------------------------

### DELETE /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

Source: https://postman.calltrackingmetrics.com/

Deletes a specific lead reactor.

```APIDOC
## DELETE /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

### Description
Removes a lead reactor from the specified account.

### Method
DELETE

### Endpoint
https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The unique identifier for the account.
- **lead_reactor_id** (string) - Required - The unique identifier for the lead reactor.
```

--------------------------------

### DELETE /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

Source: https://postman.calltrackingmetrics.com/

Deletes a specific task.

```APIDOC
## DELETE /api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

### Description
Removes a task from a lead reactor.

### Method
DELETE

### Endpoint
https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The unique identifier for the account.
- **lead_reactor_id** (string) - Required - The unique identifier for the lead reactor.
- **task_id** (string) - Required - The unique identifier for the task.
```

--------------------------------

### Update Task via cURL

Source: https://postman.calltrackingmetrics.com/

Updates an existing task using a PATCH request.

```bash
curl --location -g --request PATCH 'https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}'
```

--------------------------------

### Add Task JSON Payload

Source: https://postman.calltrackingmetrics.com/

The JSON structure required for creating a new task.

```json
{
    "contact_id": "optional contact id",
    "phone_number": "required phone number to contact",
    "name": "name of task can be name of contact or goal of task",
    "reason": "optional reason for call",
    "position": 5,
    "status": "pending",
    "fields": {"your_custom_field": "value"},

}
```

--------------------------------

### Delete Lead Reactor via cURL

Source: https://postman.calltrackingmetrics.com/

Deletes a specific lead reactor resource using a DELETE request.

```bash
curl --location -g --request DELETE 'https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}'
```

--------------------------------

### Delete Task via cURL

Source: https://postman.calltrackingmetrics.com/

Deletes a specific task using a DELETE request.

```bash
curl --location -g --request DELETE 'https://api.calltrackingmetrics.com/api/v1/accounts/{{account_id}}/lead_reactors/{{lead_reactor_id}}/tasks/{{task_id}}'
```
Tokens:
Raw