Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates?per_page=50&sort=started_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates"
);

const params = {
    "per_page": "50",
    "sort": "started_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 1,
            "project_id": 1,
            "user_id": 42,
            "rate": 85.5,
            "started_at": "2024-01-01T00:00:00.000000Z",
            "created_at": "2023-12-15T10:30:00.000000Z",
            "updated_at": "2023-12-15T10:30:00.000000Z",
            "status": "current"
        },
        {
            "id": 2,
            "project_id": 1,
            "user_id": 42,
            "rate": 75,
            "started_at": "2023-07-01T00:00:00.000000Z",
            "created_at": "2023-06-20T14:15:00.000000Z",
            "updated_at": "2023-06-20T14:15:00.000000Z",
            "status": "past"
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/projects/1/users/42/bill-rates?page=1",
        "last": "https://example.com/api/v1/projects/1/users/42/bill-rates?page=2",
        "prev": null,
        "next": "https://example.com/api/v1/projects/1/users/42/bill-rates?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://example.com/api/v1/projects/1/users/42/bill-rates",
        "per_page": 30,
        "to": 30,
        "total": 45
    }
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"started_at\": \"2024-01-01\",
    \"rate\": \"85.50\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "started_at": "2024-01-01",
    "rate": "85.50"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 3,
    "project_id": 1,
    "user_id": 42,
    "rate": 85.5,
    "started_at": "2024-01-01T00:00:00.000000Z",
    "created_at": "2023-12-20T09:45:00.000000Z",
    "updated_at": "2023-12-20T09:45:00.000000Z",
    "status": "future"
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Example response (422, duplicate_date):

{
    "message": "The given data was invalid.",
    "errors": {
        "started_at": [
            "The start date already exists for this user."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"started_at\": \"2024-02-01\",
    \"rate\": \"90.00\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "started_at": "2024-02-01",
    "rate": "90.00"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 3,
    "project_id": 1,
    "user_id": 42,
    "rate": 90,
    "started_at": "2024-02-01T00:00:00.000000Z",
    "created_at": "2023-12-20T09:45:00.000000Z",
    "updated_at": "2023-12-25T11:20:00.000000Z",
    "status": "future"
}
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Example response (404, not_found):

{
    "message": "Bill rate not found for this user"
}
 

Example response (422, duplicate_date):

{
    "message": "The given data was invalid.",
    "errors": {
        "started_at": [
            "The start date already exists for this user."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/projects/1/users/1/bill-rates/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (403, unauthorized):

{
    "message": "This action is unauthorized."
}
 

Example response (404, not_found):

{
    "message": "Bill rate not found for this user"
}
 

Example response (422, cannot_delete):

{
    "message": "The given data was invalid.",
    "errors": {
        "error": [
            "Current and past bill rate cannot be deleted"
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/boards?search=Marketing&project_id=5&per_page=50&sort=created_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/boards"
);

const params = {
    "search": "Marketing",
    "project_id": "5",
    "per_page": "50",
    "sort": "created_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 10,
            "title": "Marketing pipeline",
            "description": "High level marketing workflow.",
            "project_id": 3,
            "user_id": 14,
            "team_id": 8,
            "created_at": "2025-01-10T12:30:00.000000Z",
            "updated_at": "2025-01-10T12:30:00.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/boards?page=1",
        "last": "https://example.com/api/v1/boards?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/boards",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/boards" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Marketing pipeline\",
    \"description\": \"High level marketing workflow.\",
    \"project_id\": 3
}"

const url = new URL(
    "https://app.corcava.com/api/v1/boards"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "Marketing pipeline",
    "description": "High level marketing workflow.",
    "project_id": 3
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 10,
    "title": "Marketing pipeline",
    "description": "High level marketing workflow.",
    "project_id": 3,
    "user_id": 14,
    "team_id": 8,
    "created_at": "2025-01-10T12:30:00.000000Z",
    "updated_at": "2025-01-10T12:30:00.000000Z",
    "deleted_at": null
}
 

Example response (422, validation_error):

{
    "message": "Project not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/boards/10" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "id": 10,
    "title": "Marketing pipeline",
    "description": "High level marketing workflow.",
    "project_id": 3,
    "user_id": 14,
    "team_id": 8,
    "created_at": "2025-01-10T12:30:00.000000Z",
    "updated_at": "2025-01-10T12:30:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/boards/10" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Marketing pipeline\",
    \"description\": \"High level marketing workflow.\",
    \"project_id\": 3
}"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "Marketing pipeline",
    "description": "High level marketing workflow.",
    "project_id": 3
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 10,
    "title": "Marketing pipeline",
    "description": "High level marketing workflow.",
    "project_id": 3,
    "user_id": 14,
    "team_id": 8,
    "created_at": "2025-01-10T12:30:00.000000Z",
    "updated_at": "2025-01-10T16:45:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/boards/10" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/boards/10/export-activity?start_date=2025-01-01&end_date=2025-01-31&group_by=member&time_format=hms" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2026-09-15T03:18:22\",
    \"end_date\": \"2052-10-08\",
    \"group_by\": \"task\",
    \"time_format\": \"seconds\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10/export-activity"
);

const params = {
    "start_date": "2025-01-01",
    "end_date": "2025-01-31",
    "group_by": "member",
    "time_format": "hms",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2026-09-15T03:18:22",
    "end_date": "2052-10-08",
    "group_by": "task",
    "time_format": "seconds"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, grouped_by_member_seconds):

{
    "john doe": [
        {
            "task": "Marketing campaign",
            "time": 7200
        },
        {
            "task": "Website redesign",
            "time": 3600
        }
    ],
    "jane smith": [
        {
            "task": "Marketing campaign",
            "time": 5400
        }
    ]
}
 

Example response (200, grouped_by_task_hms):

{
    "Marketing campaign": [
        {
            "member": "john doe",
            "time": "02:00:00"
        },
        {
            "member": "jane smith",
            "time": "01:30:00"
        }
    ],
    "Website redesign": [
        {
            "member": "john doe",
            "time": "01:00:00"
        }
    ]
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Example response (422, validation_error):

{
    "message": "Invalid parameters"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/boards/10/columns" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10/columns"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 1,
            "name": "To Do",
            "is_todo": true,
            "is_done": false,
            "project_board_id": 10,
            "team_id": 1,
            "order": 0
        },
        {
            "id": 2,
            "name": "In Progress",
            "is_todo": false,
            "is_done": false,
            "project_board_id": 10,
            "team_id": 1,
            "order": 1
        }
    ]
}
 

Example response (404, not_found):

{
    "message": "Board not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/boards/10/columns" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"To Do\",
    \"is_todo\": true,
    \"is_done\": false,
    \"order\": 0
}"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10/columns"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "To Do",
    "is_todo": true,
    "is_done": false,
    "order": 0
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "data": {
        "id": 5,
        "name": "To Do",
        "is_todo": true,
        "is_done": false,
        "project_board_id": 10,
        "team_id": 1,
        "order": 0
    }
}
 

Example response (404, not_found):

{
    "message": "Board not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/boards/10/columns/5" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"In Progress\",
    \"is_todo\": false,
    \"is_done\": false,
    \"order\": 1
}"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10/columns/5"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "In Progress",
    "is_todo": false,
    "is_done": false,
    "order": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": 5,
        "name": "In Progress",
        "is_todo": false,
        "is_done": false,
        "project_board_id": 10,
        "team_id": 1,
        "order": 1
    }
}
 

Example response (404, not_found):

{
    "message": "Column not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/boards/10/columns/5" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/boards/10/columns/5"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Column not found"
}
 

Example response (422, has_tasks):

{
    "message": "Cannot delete column with tasks. Move or delete tasks first."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/emails?status=draft&contact_id=15&per_page=20" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/emails"
);

const params = {
    "status": "draft",
    "contact_id": "15",
    "per_page": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: X-Inertia
access-control-allow-origin: *
set-cookie: XSRF-TOKEN=eyJpdiI6Ill1NmpLRlo4VFo0YXNFRy9GUjlpcnc9PSIsInZhbHVlIjoidTFmd09aWkI3czZYNFI4OWFpZ3VqQWtUcEVUMFo1d1VGR2doOG1oWUd1bjRnUXEvUUZUd245dzFDdUlKY3JOU0dMaFIwVERVamcybTdYaFRrNzRneElYZXZqTzdpMlQyY3RvNUpQSFQ4d2xUQ3RES1lqYnVBOVppMVVzZlZKYUEiLCJtYWMiOiI3MGFmNzhiY2IxMjc0YmI1ZDc0YzhkZGMxYWFhNGUxZjRlZTdjZjQyZmM2OTE2OTdjZTY2N2Y4MTE2MjMzMzZhIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; samesite=lax; corcava_session=eyJpdiI6IkRVaDc0T1JaTk42bnlDOU1YN0dHNEE9PSIsInZhbHVlIjoiSEVUUmFwT3ZwNVduWmdjUGloc1NKcFJCcFc4MjQzdWppYjlSc3Y3d2sva3IzUDRNTGtuYlRpME9SbllhU2NRZFROUHBWZ2h3SXE1M1FLMXc0dW00VGNiNTNtWXc3UXdpYkNORVdiQkFQN0FoSnJDd3BhN3NQZWFVTGI4ZG83SGUiLCJtYWMiOiJmZTBlMjM3OGU0ZGU3MGZmZDA3MGI3MTBkNTM1ODQyYzg5Yzc4YTMwMTk3ZmU5MTIxMmJhMGRjM2IwYWUzMmRlIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; httponly; samesite=lax
 

{
    "message": "Invalid API Key"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/emails/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: X-Inertia
access-control-allow-origin: *
set-cookie: XSRF-TOKEN=eyJpdiI6ImZYMENsalJDMlduejZjM2xzbzJDdFE9PSIsInZhbHVlIjoidUNaT2JFM2FqVmFWR3kzZE5lR1pSR1A3V3FhYUNxK1E1T0JWWUovZ3lTYS9oTkVkbDNJZXdsWkIrTEkyVnExZjhqQklGZ1FjcTFBNm5nWXVPc3cwR2pLZmpZWTNxRFE3akhkMG44NEtFak5UYUxkNFljSjV2R2pSUjczZzZVd2MiLCJtYWMiOiJlNjM4ODVkNjA2ZjI5YThiY2M5NTYwZGZlZjYzNDBlODJlODIzZTA4MzI5NWU2ODYyMjBmNDM3ODEyY2UyNzg5IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; samesite=lax; corcava_session=eyJpdiI6IjhBdlgzWnhLdVFubWRiVDNKRjZiM1E9PSIsInZhbHVlIjoiN1N1aDJELzNyNXBwWTFXeitVWkZMMUR3NU5QYnNCWHpkYk5hOXdxQUZ3K241S29oZktrMGlmcVh6MW50UXZqZXVJcDR5dUpMN2FkUUtWNnBpdGpuMHVOS21nRy80Q1ljVnJVL2N5TzdPWmJ2WDUxQVBLZFh5cUZPd3kvQkVmMlEiLCJtYWMiOiIyODdhZjFlZjk1MjQ1YTUwY2ZjNGNkMDc4ODBiNzNkYTVjZDVhOGZiNjY5YTZkNDRkYmE2ZGUxZWIxZTA1YzdkIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; httponly; samesite=lax
 

{
    "message": "Invalid API Key"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/emails/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "to=b"\
    --form "subject=n"\
    --form "body=g"\
    --form "scheduled_at=z"\
    --form "cc[]=m"\
    --form "bcc[]=i"\
    --form "remove_attachment_ids[]=16"\
    --form "attachments[]=@/tmp/phpvmvghduach2n8kfNXIF" 

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('to', 'b');
body.append('subject', 'n');
body.append('body', 'g');
body.append('scheduled_at', 'z');
body.append('cc[]', 'm');
body.append('bcc[]', 'i');
body.append('remove_attachment_ids[]', '16');
body.append('attachments[]', document.querySelector('input[name="attachments[]"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/emails/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/emails/draft" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "contact_id=15"\
    --form "contact_ref[id]=16"\
    --form "contact_ref[email][email protected]"\
    --form "[email protected]"\
    --form "subject=Following up"\
    --form "body=<p>Hi Alex,</p><p>Thanks for your note.</p>"\
    --form "mailbox_id=3"\
    --form "[email protected]"\
    --form "from=i"\
    --form "scheduled_at=2026-07-29T09:00:00+00:00"\
    --form "cc[]=y"\
    --form "bcc[]=v"\
    --form "reply_to_incoming_email_id=45678"\
    --form "reply_to_outgoing_email_id=12345"\
    --form "remove_attachment_ids[]=16"\
    --form "attachments[]=@/tmp/php8lm9kto7jhtr9C9sXXQ" 

const url = new URL(
    "https://app.corcava.com/api/v1/emails/draft"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('contact_id', '15');
body.append('contact_ref[id]', '16');
body.append('contact_ref[email]', '[email protected]');
body.append('to', '[email protected]');
body.append('subject', 'Following up');
body.append('body', '<p>Hi Alex,</p><p>Thanks for your note.</p>');
body.append('mailbox_id', '3');
body.append('from_mailbox', '[email protected]');
body.append('from', 'i');
body.append('scheduled_at', '2026-07-29T09:00:00+00:00');
body.append('cc[]', 'y');
body.append('bcc[]', 'v');
body.append('reply_to_incoming_email_id', '45678');
body.append('reply_to_outgoing_email_id', '12345');
body.append('remove_attachment_ids[]', '16');
body.append('attachments[]', document.querySelector('input[name="attachments[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/emails/generate-draft" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 15,
    \"instruction\": \"Reply warmly and propose a call next week.\",
    \"thread_key\": \"thread:abc123\",
    \"sender_email\": \"[email protected]\",
    \"reply_to_incoming_email_id\": 45678,
    \"reply_to_outgoing_email_id\": 12345
}"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/generate-draft"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contact_id": 15,
    "instruction": "Reply warmly and propose a call next week.",
    "thread_key": "thread:abc123",
    "sender_email": "[email protected]",
    "reply_to_incoming_email_id": 45678,
    "reply_to_outgoing_email_id": 12345
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/emails/1/schedule" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"scheduled_at\": \"b\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1/schedule"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "scheduled_at": "b"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/emails/1/unschedule" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1/unschedule"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/emails/1/send" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/emails/1/send"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/inbox?search=acme&page=1&per_page=20&view=inbox&inbox_filter=unanswered" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"inbox_filter\": \"unanswered\",
    \"mailbox_ids\": [
        16
    ]
}"

const url = new URL(
    "https://app.corcava.com/api/v1/inbox"
);

const params = {
    "search": "acme",
    "page": "1",
    "per_page": "20",
    "view": "inbox",
    "inbox_filter": "unanswered",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "inbox_filter": "unanswered",
    "mailbox_ids": [
        16
    ]
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: X-Inertia
access-control-allow-origin: *
set-cookie: XSRF-TOKEN=eyJpdiI6ImlIUnNONUhDZytuWHNHREw5YTQrd2c9PSIsInZhbHVlIjoiTlVQOERYVWorVkVvcUJvWDh6OFNORXhOU2wyMU5VV3VaSkNUcGxNaWVyV01vbDg2MGdUTGN1NXRwREMvcVhaU0lqeUNMVWJaY2JwM2N0dTlNdEZLejZUeUhXZ1AxOU41R1BFc2t5WXhQUzV4UFo3cnFWZ2VBMFB0NVZ1b2ZRRHQiLCJtYWMiOiJiNzczYmU0YTBlNzM0NTIyMjE1NTA0ZGY1YjAzNzQyNGViYjVmZTg5NDZhN2U3Nzc2OGE2NTgxNmRkMmIyMmIzIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; samesite=lax; corcava_session=eyJpdiI6InFvMS85UzZnUytBQ1dIMXFMeFRwR1E9PSIsInZhbHVlIjoiWFhKOXdKWTNVQUNFY3k3YmNEQXpsVlNnLzUrb0JFVjJiWkF3SWFmTUhDeUhUcVNWWHNRaGtwUXcxVGo1K0x2SHNsdXVLamRBRVVpQURqdjl4SXBNdkZHb1pXNTlSM2wyUkxGMXUvVCsxQjgvelA4cFZjcVNuNmtPY1Z3TUxBWW0iLCJtYWMiOiJjNTJlNTNiM2I0ZjMzMzU2NWRjNjMzMzAxMmU1NDE3NzZmYzRjMWQ1MjUyNTJiYTkzMGI1M2EzMGY1YTgwYWUxIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; httponly; samesite=lax
 

{
    "message": "Invalid API Key"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/inbox/reply?incoming=45678" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"incoming\": 16
}"

const url = new URL(
    "https://app.corcava.com/api/v1/inbox/reply"
);

const params = {
    "incoming": "45678",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "incoming": 16
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: X-Inertia
access-control-allow-origin: *
set-cookie: XSRF-TOKEN=eyJpdiI6IkRxOTFpY1Bsd1ZjK1RuVm5ZVE9wRVE9PSIsInZhbHVlIjoiZWlnTEtPTFZtaitRRTBoaUp0ZTRtWitDTUxKem5XVXRKaHFCYVBWSnZFL2p2YzFHWmhQbGpiQXZJbkxCVWNXT01DTU54NjU3cENqZzA0ZlVoMHN6VDVtd0tFUzZZNnlOYTBiajh4L2JSNGdITE5WNlBzd3gzNjZTaFZoMEtBYzIiLCJtYWMiOiIwOGMwYWM0MTBhMDAyNjI0MTE5YjQ0MjAxZDMyMjAwNzA1ODAxY2I0ZjVkZDY2ZDlkNzBkNmQyOTM3YzI5YmQ2IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; samesite=lax; corcava_session=eyJpdiI6ImRJbWlacUNYV3hPNW5CUS9MbXhsSEE9PSIsInZhbHVlIjoiM3p2YW05QVRUWVVjUUwzN3NoVEF6RFFQaVFPZkVBNks1NXJhSnhsVmNkdkxYTnNmOWVMUFBGZzkybGJ0MTVEUHlHUWdrd3FDeHZFWUhBeGg4TGRENDBwZ0MvYVdodDVLMGRxRy9BL2ZtWmpuRFVpd2VuVDJkb1ZMSjdwanBDQ3AiLCJtYWMiOiJlOTQ2MWNmZTFjNjIxNGM2OWFiODA4ZTc0ZmI5Yzk3NzVkMDVjNmE1YjBmOTMyZjY4MGUwYzMyY2EwMDBkZmY0IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; httponly; samesite=lax
 

{
    "message": "Invalid API Key"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/inbox/threads?thread_key=thread%3Aabc123&from=alex%40example.com&sender_scope=s%3Aalex%40example.com&view=inbox" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"thread_key\": \"b\",
    \"sender_scope\": \"n\",
    \"view\": \"inbox\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/inbox/threads"
);

const params = {
    "thread_key": "thread:abc123",
    "from": "[email protected]",
    "sender_scope": "s:[email protected]",
    "view": "inbox",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "thread_key": "b",
    "sender_scope": "n",
    "view": "inbox"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
vary: X-Inertia
access-control-allow-origin: *
set-cookie: XSRF-TOKEN=eyJpdiI6ImZXS2d5Y0pZdGMrZkQ2MXlQZ0RPVnc9PSIsInZhbHVlIjoiSG51MU9SRkh5WEdzQWNhR1NKd2NIY0JwZkF5Q3p3ZGFqYWc0ZnQ4bUwzOVBTRUFLVTFwenhtdGJiM2ZYSks3cVRUczFZZ21heS9GUFhHR2VvKy9nQUlNYjZNeHRxamh5eHg4NHFoSEdXNEhuZDRqWktrRVBJM2dKTEhsQ2dBelYiLCJtYWMiOiJlYjg0OGM0ZTQwM2MzYTY4ZTUwZjg0Y2FkYTUxY2MxYjYwYWViZjQyZTY5Y2I0YzVjYTg4YjhkYzc2YmE1NzBiIiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; samesite=lax; corcava_session=eyJpdiI6InZXMUVYbGRHMWYzTHVkeHdmaFNkOWc9PSIsInZhbHVlIjoiV2JkZTRVTndiMzRjZHhEdWxGekdWY2NZM2s3Wi9CenJUOTV2b2tVRXgxTllOR3oxZXA0VW1aZHVVOEh0VkErb1FPbjc5SWRiRG84M3ZzRFQxN2hsMlViUVdsTFpCWEgxSVNkYVk3aUthckZCN2RvdW9zUGZMV0ZKM0pkK0pWOWEiLCJtYWMiOiIxNzYxZjE3Y2I4YTA2Njc5OGNhNDEzNTM3NWNjYjRkZmI4MjFhOTg3ZWQyNjc1Y2ViZTI0NTgwN2UwZjRmNWI2IiwidGFnIjoiIn0%3D; expires=Thu, 17 Sep 2026 03:18:23 GMT; Max-Age=172800; path=/; secure; httponly; samesite=lax
 

{
    "message": "Invalid API Key"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/clients?search=ACME&user_id=12&is_stripe=1&is_crypto_payments=&per_page=50&sort=created_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/clients"
);

const params = {
    "search": "ACME",
    "user_id": "12",
    "is_stripe": "1",
    "is_crypto_payments": "0",
    "per_page": "50",
    "sort": "created_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 4,
            "company_name": "ACME Inc.",
            "contact_name": "Alex Johnson",
            "display_name": "ACME Inc.",
            "currency_id": 1,
            "phone": "+1 202 555 0147",
            "email": "[email protected]",
            "address_1": "123 Main St",
            "address_2": null,
            "zip": "10001",
            "country": "USA",
            "city": "New York",
            "stripe_id": null,
            "is_crypto_payments": false,
            "is_stripe": false,
            "notes": "Key enterprise account.",
            "user_id": 12,
            "team_id": 8,
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T08:00:00.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/clients?page=1",
        "last": "https://example.com/api/v1/clients?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/clients",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/clients" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"ACME Inc.\",
    \"contact_name\": \"Alex Johnson\",
    \"currency_id\": 1,
    \"phone\": \"+1 202 555 0147\",
    \"email\": \"[email protected]\",
    \"address_1\": \"123 Main St\",
    \"address_2\": \"Suite 502\",
    \"zip\": \"10001\",
    \"country\": \"USA\",
    \"city\": \"New York\",
    \"stripe_id\": \"cus_abc123\",
    \"is_crypto_payments\": false,
    \"is_stripe\": true,
    \"notes\": \"Key enterprise account.\",
    \"user_id\": 12,
    \"tag_names\": [
        \"n\"
    ],
    \"add_tag_names\": [
        \"g\"
    ],
    \"remove_tag_names\": [
        \"z\"
    ],
    \"create_missing_tags\": false
}"

const url = new URL(
    "https://app.corcava.com/api/v1/clients"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "ACME Inc.",
    "contact_name": "Alex Johnson",
    "currency_id": 1,
    "phone": "+1 202 555 0147",
    "email": "[email protected]",
    "address_1": "123 Main St",
    "address_2": "Suite 502",
    "zip": "10001",
    "country": "USA",
    "city": "New York",
    "stripe_id": "cus_abc123",
    "is_crypto_payments": false,
    "is_stripe": true,
    "notes": "Key enterprise account.",
    "user_id": 12,
    "tag_names": [
        "n"
    ],
    "add_tag_names": [
        "g"
    ],
    "remove_tag_names": [
        "z"
    ],
    "create_missing_tags": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 4,
    "company_name": "ACME Inc.",
    "contact_name": "Alex Johnson",
    "display_name": "ACME Inc.",
    "currency_id": 1,
    "phone": "+1 202 555 0147",
    "email": "[email protected]",
    "address_1": "123 Main St",
    "address_2": null,
    "zip": "10001",
    "country": "USA",
    "city": "New York",
    "stripe_id": null,
    "is_crypto_payments": false,
    "is_stripe": false,
    "notes": "Key enterprise account.",
    "user_id": 12,
    "team_id": 8,
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T08:00:00.000000Z",
    "deleted_at": null
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/clients/4" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/clients/4"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "id": 4,
    "company_name": "ACME Inc.",
    "contact_name": "Alex Johnson",
    "display_name": "ACME Inc.",
    "currency_id": 1,
    "phone": "+1 202 555 0147",
    "email": "[email protected]",
    "address_1": "123 Main St",
    "address_2": null,
    "zip": "10001",
    "country": "USA",
    "city": "New York",
    "stripe_id": null,
    "is_crypto_payments": false,
    "is_stripe": false,
    "notes": "Key enterprise account.",
    "user_id": 12,
    "team_id": 8,
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T08:00:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/clients/4" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"ACME Inc.\",
    \"contact_name\": \"Alex Johnson\",
    \"currency_id\": 1,
    \"phone\": \"+1 202 555 0147\",
    \"email\": \"[email protected]\",
    \"address_1\": \"123 Main St\",
    \"address_2\": \"Suite 502\",
    \"zip\": \"10001\",
    \"country\": \"USA\",
    \"city\": \"New York\",
    \"stripe_id\": \"cus_abc123\",
    \"is_crypto_payments\": false,
    \"is_stripe\": true,
    \"notes\": \"Key enterprise account.\",
    \"user_id\": 12,
    \"tag_names\": [
        \"n\"
    ],
    \"add_tag_names\": [
        \"g\"
    ],
    \"remove_tag_names\": [
        \"z\"
    ],
    \"create_missing_tags\": true
}"

const url = new URL(
    "https://app.corcava.com/api/v1/clients/4"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "ACME Inc.",
    "contact_name": "Alex Johnson",
    "currency_id": 1,
    "phone": "+1 202 555 0147",
    "email": "[email protected]",
    "address_1": "123 Main St",
    "address_2": "Suite 502",
    "zip": "10001",
    "country": "USA",
    "city": "New York",
    "stripe_id": "cus_abc123",
    "is_crypto_payments": false,
    "is_stripe": true,
    "notes": "Key enterprise account.",
    "user_id": 12,
    "tag_names": [
        "n"
    ],
    "add_tag_names": [
        "g"
    ],
    "remove_tag_names": [
        "z"
    ],
    "create_missing_tags": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 4,
    "company_name": "ACME Inc.",
    "contact_name": "Alex Johnson",
    "display_name": "ACME Inc.",
    "currency_id": 1,
    "phone": "+1 202 555 0147",
    "email": "[email protected]",
    "address_1": "123 Main St",
    "address_2": null,
    "zip": "10001",
    "country": "USA",
    "city": "New York",
    "stripe_id": null,
    "is_crypto_payments": false,
    "is_stripe": false,
    "notes": "Key enterprise account.",
    "user_id": 12,
    "team_id": 8,
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T11:30:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/clients/4" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/clients/4"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/contacts/1/notes?per_page=20" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/notes"
);

const params = {
    "per_page": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 7,
            "contact_id": 15,
            "user_id": 12,
            "text": "Meeting scheduled for next Tuesday to discuss project requirements.",
            "created_at": "2025-01-15T10:30:00.000000Z",
            "updated_at": "2025-01-15T10:30:00.000000Z"
        },
        {
            "id": 6,
            "contact_id": 15,
            "user_id": 8,
            "text": "Client requested a callback regarding pricing.",
            "created_at": "2025-01-14T14:20:00.000000Z",
            "updated_at": "2025-01-14T14:20:00.000000Z"
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/contacts/15/notes?page=1",
        "last": "https://example.com/api/v1/contacts/15/notes?page=2",
        "prev": null,
        "next": "https://example.com/api/v1/contacts/15/notes?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "path": "https://example.com/api/v1/contacts/15/notes",
        "per_page": 20,
        "to": 20,
        "total": 35
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/contacts/1/notes" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"Meeting scheduled for next Tuesday to discuss project requirements.\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/notes"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "Meeting scheduled for next Tuesday to discuss project requirements."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 7,
    "contact_id": 15,
    "user_id": 12,
    "text": "Meeting scheduled for next Tuesday to discuss project requirements.",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
}
 

Example response (422, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "text": [
            "The text field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/contacts/1/notes/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"text\": \"Meeting rescheduled to Wednesday due to client availability.\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/notes/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "text": "Meeting rescheduled to Wednesday due to client availability."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 7,
    "contact_id": 15,
    "user_id": 12,
    "text": "Meeting rescheduled to Wednesday due to client availability.",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-16T09:15:00.000000Z"
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Example response (422, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "text": [
            "The text field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/contacts/1/notes/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/notes/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/contacts/1/tasks?per_page=30" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/tasks"
);

const params = {
    "per_page": "30",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 3,
            "contact_id": 15,
            "user_id": 7,
            "due_at": "2025-02-01T12:00:00.000000Z",
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T08:00:00.000000Z"
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/contacts/15/tasks?page=1",
        "last": "https://example.com/api/v1/contacts/15/tasks?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/contacts/15/tasks",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/contacts/1/tasks" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"description\": \"Eius et animi quos velit et.\",
    \"status\": \"v\",
    \"due_at\": \"2025-02-01T12:00:00Z\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/tasks"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "description": "Eius et animi quos velit et.",
    "status": "v",
    "due_at": "2025-02-01T12:00:00Z"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 3,
    "contact_id": 15,
    "user_id": 7,
    "due_at": "2025-02-01T12:00:00.000000Z",
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T08:00:00.000000Z"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/contacts/1/tasks/8" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"description\": \"Eius et animi quos velit et.\",
    \"status\": \"v\",
    \"due_at\": \"2025-02-05T09:00:00Z\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/tasks/8"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "b",
    "description": "Eius et animi quos velit et.",
    "status": "v",
    "due_at": "2025-02-05T09:00:00Z"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 3,
    "contact_id": 15,
    "user_id": 7,
    "due_at": "2025-02-05T09:00:00.000000Z",
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-11T10:30:00.000000Z"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/contacts/1/tasks/8" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/1/tasks/8"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/contacts?search=John+Doe&client_id=4&user_id=12&per_page=50&sort=created_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts"
);

const params = {
    "search": "John Doe",
    "client_id": "4",
    "user_id": "12",
    "per_page": "50",
    "sort": "created_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 21,
            "client_id": 4,
            "first_name": "Alex",
            "last_name": "Johnson",
            "display_name": "Alex Johnson",
            "company_name": "ACME Inc.",
            "website": "https://acme.inc",
            "email": "[email protected]",
            "phone": "+1 202 555 0147",
            "user_id": 12,
            "team_id": 8,
            "skype": null,
            "telegram": "@alex",
            "linkedin": "https://linkedin.com/in/alex",
            "birth_date": "1992-09-15",
            "last_contacted_at": "2025-01-10T15:00:00.000000Z",
            "address_line_1": "123 Main St",
            "city": "New York",
            "zip": "10001",
            "country": "USA",
            "description": "Primary decision maker",
            "goal": "Close enterprise deal by Q3",
            "outreach_id": null,
            "company_id": null,
            "custom_fields": {
                "extra emails": "[email protected], [email protected]",
                "foo-bar": "[email protected]"
            },
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T15:00:00.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/contacts?page=1",
        "last": "https://example.com/api/v1/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/contacts",
        "per_page": 50,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/contacts" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"Alex\",
    \"last_name\": \"Johnson\",
    \"company_name\": \"ACME Inc.\",
    \"website\": \"https:\\/\\/acme.inc\",
    \"client_id\": 4,
    \"email\": \"[email protected]\",
    \"phone\": \"+1 202 555 0147\",
    \"user_id\": 12,
    \"skype\": \"j\",
    \"telegram\": \"@alex\",
    \"linkedin\": \"https:\\/\\/linkedin.com\\/in\\/alex\",
    \"birth_date\": \"2026-09-15T03:18:22\",
    \"last_contacted_at\": \"2026-09-15T03:18:22\",
    \"address_line_1\": \"k\",
    \"city\": \"h\",
    \"zip\": \"w\",
    \"country\": \"a\",
    \"description\": \"Primary decision maker\",
    \"goal\": \"Close enterprise deal by Q3\",
    \"outreach_id\": 16,
    \"company_id\": 16,
    \"custom_fields\": {
        \"extra emails\": \"[email protected], [email protected]\",
        \"foo-bar\": \"[email protected]\"
    },
    \"client_ref\": {
        \"id\": 16,
        \"name\": \"n\"
    },
    \"tag_names\": [
        \"g\"
    ],
    \"add_tag_names\": [
        \"z\"
    ],
    \"remove_tag_names\": [
        \"m\"
    ],
    \"create_missing_tags\": true
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "Alex",
    "last_name": "Johnson",
    "company_name": "ACME Inc.",
    "website": "https:\/\/acme.inc",
    "client_id": 4,
    "email": "[email protected]",
    "phone": "+1 202 555 0147",
    "user_id": 12,
    "skype": "j",
    "telegram": "@alex",
    "linkedin": "https:\/\/linkedin.com\/in\/alex",
    "birth_date": "2026-09-15T03:18:22",
    "last_contacted_at": "2026-09-15T03:18:22",
    "address_line_1": "k",
    "city": "h",
    "zip": "w",
    "country": "a",
    "description": "Primary decision maker",
    "goal": "Close enterprise deal by Q3",
    "outreach_id": 16,
    "company_id": 16,
    "custom_fields": {
        "extra emails": "[email protected], [email protected]",
        "foo-bar": "[email protected]"
    },
    "client_ref": {
        "id": 16,
        "name": "n"
    },
    "tag_names": [
        "g"
    ],
    "add_tag_names": [
        "z"
    ],
    "remove_tag_names": [
        "m"
    ],
    "create_missing_tags": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 21,
    "client_id": 4,
    "first_name": "Alex",
    "last_name": "Johnson",
    "display_name": "Alex Johnson",
    "company_name": "ACME Inc.",
    "website": "https://acme.inc",
    "email": "[email protected]",
    "phone": "+1 202 555 0147",
    "user_id": 12,
    "team_id": 8,
    "skype": null,
    "telegram": "@alex",
    "linkedin": "https://linkedin.com/in/alex",
    "birth_date": "1992-09-15",
    "last_contacted_at": null,
    "address_line_1": "123 Main St",
    "city": "New York",
    "zip": "10001",
    "country": "USA",
    "description": "Primary decision maker",
    "goal": "Close enterprise deal by Q3",
    "outreach_id": null,
    "company_id": null,
    "custom_fields": {
        "extra emails": "[email protected], [email protected]",
        "foo-bar": "[email protected]"
    },
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T08:00:00.000000Z",
    "deleted_at": null
}
 

Example response (422, validation_error):

{
    "message": "Client not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/contacts/21" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/21"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "id": 21,
    "client_id": 4,
    "first_name": "Alex",
    "last_name": "Johnson",
    "display_name": "Alex Johnson",
    "company_name": "ACME Inc.",
    "website": "https://acme.inc",
    "email": "[email protected]",
    "phone": "+1 202 555 0147",
    "user_id": 12,
    "team_id": 8,
    "skype": null,
    "telegram": "@alex",
    "linkedin": "https://linkedin.com/in/alex",
    "birth_date": "1992-09-15",
    "last_contacted_at": "2025-01-10T15:00:00.000000Z",
    "address_line_1": "123 Main St",
    "city": "New York",
    "zip": "10001",
    "country": "USA",
    "description": "Primary decision maker",
    "goal": "Close enterprise deal by Q3",
    "outreach_id": null,
    "company_id": null,
    "custom_fields": {
        "extra emails": "[email protected], [email protected]",
        "foo-bar": "[email protected]"
    },
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T15:00:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/contacts/21" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"Alex\",
    \"last_name\": \"Johnson\",
    \"company_name\": \"g\",
    \"website\": \"z\",
    \"client_id\": 4,
    \"email\": \"[email protected]\",
    \"phone\": \"+1 202 555 0147\",
    \"user_id\": 12,
    \"skype\": \"j\",
    \"telegram\": \"n\",
    \"linkedin\": \"i\",
    \"birth_date\": \"2026-09-15T03:18:22\",
    \"last_contacted_at\": \"2026-09-15T03:18:22\",
    \"address_line_1\": \"k\",
    \"city\": \"h\",
    \"zip\": \"w\",
    \"country\": \"a\",
    \"description\": \"Primary decision maker\",
    \"goal\": \"Close enterprise deal by Q3\",
    \"outreach_id\": 16,
    \"company_id\": 16,
    \"custom_fields\": {
        \"extra emails\": \"[email protected], [email protected]\"
    },
    \"client_ref\": {
        \"id\": 16,
        \"name\": \"n\"
    },
    \"tag_names\": [
        \"g\"
    ],
    \"add_tag_names\": [
        \"z\"
    ],
    \"remove_tag_names\": [
        \"m\"
    ],
    \"create_missing_tags\": true
}"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/21"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "Alex",
    "last_name": "Johnson",
    "company_name": "g",
    "website": "z",
    "client_id": 4,
    "email": "[email protected]",
    "phone": "+1 202 555 0147",
    "user_id": 12,
    "skype": "j",
    "telegram": "n",
    "linkedin": "i",
    "birth_date": "2026-09-15T03:18:22",
    "last_contacted_at": "2026-09-15T03:18:22",
    "address_line_1": "k",
    "city": "h",
    "zip": "w",
    "country": "a",
    "description": "Primary decision maker",
    "goal": "Close enterprise deal by Q3",
    "outreach_id": 16,
    "company_id": 16,
    "custom_fields": {
        "extra emails": "[email protected], [email protected]"
    },
    "client_ref": {
        "id": 16,
        "name": "n"
    },
    "tag_names": [
        "g"
    ],
    "add_tag_names": [
        "z"
    ],
    "remove_tag_names": [
        "m"
    ],
    "create_missing_tags": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 21,
    "client_id": 4,
    "first_name": "Alex",
    "last_name": "Johnson",
    "display_name": "Alex Johnson",
    "company_name": "ACME Inc.",
    "website": "https://acme.inc",
    "email": "[email protected]",
    "phone": "+1 202 555 0147",
    "user_id": 12,
    "team_id": 8,
    "skype": null,
    "telegram": "@alex",
    "linkedin": "https://linkedin.com/in/alex",
    "birth_date": "1992-09-15",
    "last_contacted_at": "2025-01-10T15:00:00.000000Z",
    "address_line_1": "123 Main St",
    "city": "New York",
    "zip": "10001",
    "country": "USA",
    "description": "Primary decision maker",
    "goal": "Close enterprise deal by Q3",
    "outreach_id": null,
    "company_id": null,
    "custom_fields": {
        "extra emails": "[email protected], [email protected]",
        "foo-bar": "[email protected]"
    },
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T18:30:00.000000Z",
    "deleted_at": null
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/contacts/21" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/contacts/21"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/custom-fields?per_page=50&sort=created_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/custom-fields"
);

const params = {
    "per_page": "50",
    "sort": "created_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 1,
            "name": "priority",
            "label": "Priority",
            "team_id": 8,
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T08:00:00.000000Z"
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/custom-fields?page=1",
        "last": "https://example.com/api/v1/custom-fields?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/custom-fields",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/custom-fields" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"priority\",
    \"type\": \"string\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/custom-fields"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "priority",
    "type": "string"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 1,
    "name": "priority",
    "label": "Priority",
    "team_id": 8,
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-10T08:00:00.000000Z"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/custom-fields/3" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"priority\",
    \"type\": \"string\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/custom-fields/3"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "priority",
    "type": "string"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 1,
    "name": "priority",
    "label": "Priority",
    "team_id": 8,
    "created_at": "2025-01-10T08:00:00.000000Z",
    "updated_at": "2025-01-11T10:30:00.000000Z"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/custom-fields/3" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/custom-fields/3"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/deal-columns?name=Proposal&sort=order&direction=asc&per_page=50" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deal-columns"
);

const params = {
    "name": "Proposal",
    "sort": "order",
    "direction": "asc",
    "per_page": "50",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 1,
            "name": "Qualified Lead",
            "board_id": 5,
            "team_id": 8,
            "deal_probability": "30%",
            "order": 0,
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T08:00:00.000000Z",
            "deleted_at": null
        },
        {
            "id": 2,
            "name": "Proposal Made",
            "board_id": 5,
            "team_id": 8,
            "deal_probability": "50%",
            "order": 1,
            "created_at": "2025-01-10T08:00:00.000000Z",
            "updated_at": "2025-01-10T08:00:00.000000Z",
            "deleted_at": null
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/deal-columns?page=1",
        "last": "https://example.com/api/v1/deal-columns?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/deal-columns",
        "per_page": 30,
        "to": 2,
        "total": 2
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/deal-columns" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Proposal Made\",
    \"board_id\": 5,
    \"deal_probability\": \"50%\",
    \"order\": 2
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deal-columns"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Proposal Made",
    "board_id": 5,
    "deal_probability": "50%",
    "order": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "data": {
        "id": 3,
        "name": "Proposal Made",
        "board_id": 5,
        "team_id": 8,
        "deal_probability": "50%",
        "order": 2,
        "created_at": "2025-01-10T10:00:00.000000Z",
        "updated_at": "2025-01-10T10:00:00.000000Z",
        "deleted_at": null
    },
    "message": "Column created successfully"
}
 

Example response (422, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field is required."
        ],
        "board_id": [
            "The selected board id is invalid."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/deal-columns/3" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Proposal Submitted\",
    \"board_id\": 5,
    \"deal_probability\": \"60%\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deal-columns/3"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Proposal Submitted",
    "board_id": 5,
    "deal_probability": "60%"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": 3,
        "name": "Proposal Submitted",
        "board_id": 5,
        "team_id": 8,
        "deal_probability": "60%",
        "order": 3,
        "created_at": "2025-01-10T10:00:00.000000Z",
        "updated_at": "2025-01-10T11:30:00.000000Z",
        "deleted_at": null
    },
    "message": "Column updated successfully"
}
 

Example response (404, not_found):

{
    "message": "Column not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/deal-columns/3" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deal-columns/3"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Column deleted successfully"
}
 

Example response (404, not_found):

{
    "message": "Column not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/deal-columns/3/order" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order\": 1
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deal-columns/3/order"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "data": {
        "id": 3,
        "name": "Proposal Made",
        "board_id": 5,
        "team_id": 8,
        "deal_probability": "50%",
        "order": 1,
        "created_at": "2025-01-10T10:00:00.000000Z",
        "updated_at": "2025-01-10T12:00:00.000000Z",
        "deleted_at": null
    },
    "message": "Column order updated successfully"
}
 

Example response (404, not_found):

{
    "message": "Column not found"
}
 

Example response (422, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "order": [
            "The order field is required."
        ]
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/deals?search=b&user_id=16&column_id=16&contact_id=16&date_from=2026-09-15T03%3A18%3A22&date_to=2026-09-15T03%3A18%3A22&sort=name&direction=desc&per_page=22" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deals"
);

const params = {
    "search": "b",
    "user_id": "16",
    "column_id": "16",
    "contact_id": "16",
    "date_from": "2026-09-15T03:18:22",
    "date_to": "2026-09-15T03:18:22",
    "sort": "name",
    "direction": "desc",
    "per_page": "22",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 1,
            "name": "Big Deal",
            "slug": "big-deal",
            "outreach_id": 3,
            "company_id": 7,
            "contact_id": 15,
            "user_id": 5,
            "team_id": 2,
            "description": "This is a very important deal.",
            "column_id": 4,
            "closed_at": "2024-05-01T00:00:00.000000Z",
            "amount": "10000.00",
            "order": 1,
            "created_at": "2024-04-01T12:00:00.000000Z",
            "updated_at": "2024-04-15T15:30:00.000000Z",
            "deleted_at": null
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 3,
        "per_page": 30,
        "to": 30,
        "total": 75
    }
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/deals/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deals/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "id": 1,
    "name": "Big Deal",
    "slug": "big-deal",
    "outreach_id": 3,
    "company_id": 7,
    "contact_id": 15,
    "user_id": 5,
    "team_id": 2,
    "description": "This is a very important deal.",
    "column_id": 4,
    "closed_at": "2024-05-01T00:00:00.000000Z",
    "amount": "10000.00",
    "order": 1,
    "created_at": "2024-04-01T12:00:00.000000Z",
    "updated_at": "2024-04-15T15:30:00.000000Z",
    "deleted_at": null
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{"message": "This action is unauthorized
 

Example response (404, not_found):

{
    "message": "Deal not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/deals" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"\\\"New Deal\\\"\",
    \"description\": \"\\\"This deal is very promising.\\\"\",
    \"closed_at\": \"\\\"2024-06-30\\\"\",
    \"outreach_id\": 3,
    \"contact_id\": 15,
    \"company_id\": 7,
    \"amount\": \"\\\"5000.00\\\"\",
    \"column_id\": 4,
    \"user_id\": 5,
    \"attachments\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deals"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "\"New Deal\"",
    "description": "\"This deal is very promising.\"",
    "closed_at": "\"2024-06-30\"",
    "outreach_id": 3,
    "contact_id": 15,
    "company_id": 7,
    "amount": "\"5000.00\"",
    "column_id": 4,
    "user_id": 5,
    "attachments": [
        "architecto"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, created):

{
    "id": 2,
    "name": "New Deal",
    "slug": "new-deal",
    "outreach_id": 3,
    "company_id": 7,
    "contact_id": 15,
    "user_id": 5,
    "team_id": 2,
    "description": "This deal is very promising.",
    "column_id": 4,
    "closed_at": "2024-06-30T00:00:00.000000Z",
    "amount": "5000.00",
    "order": 2,
    "created_at": "2024-05-01T10:00:00.000000Z",
    "updated_at": "2024-05-01T10:00:00.000000Z",
    "deleted_at": null
}
 

Example response (400, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field is required."
        ]
    }
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{
    "message": "This action is unauthorized."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/deals/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"\\\"Updated Deal Name\\\"\",
    \"description\": \"\\\"Updated description.\\\"\",
    \"closed_at\": \"\\\"2024-07-15\\\"\",
    \"outreach_id\": 4,
    \"contact_id\": 16,
    \"company_id\": 8,
    \"amount\": \"\\\"7500.00\\\"\",
    \"user_id\": 6,
    \"attachments\": [
        \"architecto\"
    ]
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deals/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "\"Updated Deal Name\"",
    "description": "\"Updated description.\"",
    "closed_at": "\"2024-07-15\"",
    "outreach_id": 4,
    "contact_id": 16,
    "company_id": 8,
    "amount": "\"7500.00\"",
    "user_id": 6,
    "attachments": [
        "architecto"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 1,
    "name": "Updated Deal Name",
    "slug": "updated-deal-name",
    "outreach_id": 4,
    "company_id": 8,
    "contact_id": 16,
    "user_id": 6,
    "team_id": 2,
    "description": "Updated description.",
    "column_id": 5,
    "closed_at": "2024-07-15T00:00:00.000000Z",
    "amount": "7500.00",
    "order": 1,
    "created_at": "2024-04-01T12:00:00.000000Z",
    "updated_at": "2024-05-10T14:20:00.000000Z",
    "deleted_at": null
}
 

Example response (400, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "name": [
            "The name field must not be greater than 255 characters."
        ]
    }
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{
    "message": "This action is unauthorized."
}
 

Example response (404, not_found):

{
    "message": "Deal not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/deals/1" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deals/1"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Deal deleted successfully."
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{
    "message": "This action is unauthorized."
}
 

Example response (404, not_found):

{
    "message": "Deal not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/deals/order" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order\": 3,
    \"column_id\": 2
}"

const url = new URL(
    "https://app.corcava.com/api/v1/deals/order"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order": 3,
    "column_id": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{"data": { ...deal data... }, "message": "Deal order updated successfully."}
 

Example response (400, validation_error):

{
    "message": "The given data was invalid.",
    "errors": {
        "order": [
            "The order field is required."
        ]
    }
}
 

Example response (401, unauthenticated):

{
    "message": "Unauthenticated."
}
 

Example response (403, forbidden):

{
    "message": "This action is unauthorized."
}
 

Example response (404, not_found):

{
    "message": "Deal not found."
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/deals/2070/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/deals/2070/order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/email-campaigns?per_page=20&sort=created_at&direction=desc" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns"
);

const params = {
    "per_page": "20",
    "sort": "created_at",
    "direction": "desc",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "data": [
        {
            "id": 12,
            "user_id": 5,
            "team_id": 3,
            "email_template_id": 7,
            "name": "January Newsletter",
            "scheduled_at": "2025-02-01T10:00:00.000000Z",
            "email_type": "template",
            "text_editor": null,
            "created_at": "2025-01-20T08:30:00.000000Z",
            "updated_at": "2025-01-20T08:30:00.000000Z"
        }
    ],
    "links": {
        "first": "https://example.com/api/v1/email-campaigns?page=1",
        "last": "https://example.com/api/v1/email-campaigns?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://example.com/api/v1/email-campaigns",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://app.corcava.com/api/v1/email-campaigns/12" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns/12"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "id": 12,
    "user_id": 5,
    "team_id": 3,
    "email_template_id": 7,
    "name": "January Newsletter",
    "scheduled_at": "2025-02-01T10:00:00.000000Z",
    "email_type": "template",
    "text_editor": null,
    "created_at": "2025-01-20T08:30:00.000000Z",
    "updated_at": "2025-01-20T08:30:00.000000Z"
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/email-campaigns" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"January Newsletter\",
    \"scheduled_at\": \"2025-02-01T10:00:00Z\",
    \"email_type\": \"template\",
    \"email_template_id\": 7,
    \"text_editor\": \"Hello, this is our newsletter.\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "January Newsletter",
    "scheduled_at": "2025-02-01T10:00:00Z",
    "email_type": "template",
    "email_template_id": 7,
    "text_editor": "Hello, this is our newsletter."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201, success):

{
    "id": 12,
    "user_id": 5,
    "team_id": 3,
    "email_template_id": 7,
    "name": "January Newsletter",
    "scheduled_at": "2025-02-01T10:00:00.000000Z",
    "email_type": "template",
    "text_editor": null,
    "created_at": "2025-01-20T08:30:00.000000Z",
    "updated_at": "2025-01-20T08:30:00.000000Z"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://app.corcava.com/api/v1/email-campaigns/12" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"February Newsletter\",
    \"scheduled_at\": \"2025-02-15T10:00:00Z\",
    \"email_type\": \"text_editor\",
    \"email_template_id\": 7,
    \"text_editor\": \"architecto\"
}"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns/12"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "February Newsletter",
    "scheduled_at": "2025-02-15T10:00:00Z",
    "email_type": "text_editor",
    "email_template_id": 7,
    "text_editor": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, success):

{
    "id": 12,
    "name": "February Newsletter",
    "email_type": "text_editor",
    "scheduled_at": "2025-02-15T10:00:00.000000Z",
    "updated_at": "2025-01-25T09:00:00.000000Z"
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request DELETE \
    "https://app.corcava.com/api/v1/email-campaigns/12" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns/12"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (204, success):

Empty response
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://app.corcava.com/api/v1/email-campaigns/12/send" \
    --header "X-API-Key: {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "https://app.corcava.com/api/v1/email-campaigns/12/send"
);

const headers = {
    "X-API-Key": "{YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, success):

{
    "message": "Email campaign sent successfully"
}
 

Example response (404, not_found):

{
    "message": "Not found"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.