Campaign

Pipeline

Pipeline endpoints

Get All

Description

Get all pipelines.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

200

Type:

Array of Pipeline objects

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/institution/:institutionId/pipeline/

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/ \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Get by id

Description

Find the pipeline that matches the {pipelineId} query parameter.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/institution/:institutionId/pipeline/:pipelineId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Create

Description

Create a new pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/pipeline/

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/ \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Update

Description

Update an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/institution/:institutionId/pipeline/:pipelineId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Delete

Description

Delete an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

delete

/institution/:institutionId/pipeline/:pipelineId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Unarchive

Description

Unarchive an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/institution/:institutionId/pipeline/:pipelineId/unarchive

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/unarchive \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Create Stage

Description

Create a new stage in an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

body

name

string

Required

Description:

The name of the stage

Example:

"Lead"

order

number

Required

Description:

The order of the stage

Example:

probability

number

Required

Description:

The probability of the stage

Example:

0.5

leads

array

Description:

The leads of the stage

Example:

leads

Responses

200

Type:

PipelineStage object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Lead",
    order: 1,
    probability: 0.5,
    leads: [
        "0f9c0b0b4f0c6b0017f0e3b1",
        "0f9c0b0b4f0c6b0017f0e3b2"
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/pipeline/:pipelineId/stage

Request

1
2
3
4
5
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/stage \
    -X POST \
    -H 'Authorization: Bearer <token>' \
    -H \'Content-Type: application/json\' \
	--data-raw '{"name":"\"Lead\""}'

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Lead",
    order: 1,
    probability: 0.5,
    leads: [
        "0f9c0b0b4f0c6b0017f0e3b1",
        "0f9c0b0b4f0c6b0017f0e3b2"
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Update Stage

Description

Update an existing stage in an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

stageId

string

Required

Description:

The id of the stage

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

PipelineStage object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Lead",
    order: 1,
    probability: 0.5,
    leads: [
        "0f9c0b0b4f0c6b0017f0e3b1",
        "0f9c0b0b4f0c6b0017f0e3b2"
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

401

Unauthorized

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

404

Not Found

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

500

Internal Server Error

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/institution/:institutionId/pipeline/:pipelineId/stage/:stageId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/stage/:stageId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Lead",
    order: 1,
    probability: 0.5,
    leads: [
        "0f9c0b0b4f0c6b0017f0e3b1",
        "0f9c0b0b4f0c6b0017f0e3b2"
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Delete Stage

Description

Delete an existing stage in an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

stageId

string

Required

Description:

The id of the stage

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

delete

/institution/:institutionId/pipeline/:pipelineId/stage/:stageId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/stage/:stageId \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Add Lead to Stage

Description

Add a lead to an existing stage in an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

stageId

string

Required

Description:

The id of the stage

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

leadId

string

Required

Description:

The id of the lead

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

put

/institution/:institutionId/pipeline/:pipelineId/stage/:stageId/lead/:leadId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/stage/:stageId/lead/:leadId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Remove Lead from Stage

Description

Remove a lead from an existing stage in an existing pipeline.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

pipelineId

string

Required

Description:

The id of the pipeline

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

stageId

string

Required

Description:

The id of the stage

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

leadId

string

Required

Description:

The id of the lead

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

200

Type:

Pipeline object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

delete

/institution/:institutionId/pipeline/:pipelineId/stage/:stageId/lead/:leadId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/pipeline/:pipelineId/stage/:stageId/lead/:leadId \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "1a2b3c4d5e6f7g8h9i0j1k2l",
    name: "Sales Pipeline",
    stages: [
        {
            __type: "PipelineStage",
            _id: {
                key: "_id",
                type: "string",
                example: "0f9c0b0b4f0c6b0017f0e3b1"
            },
            name: {
                key: "name",
                type: "string",
                example: "Lead"
            },
            order: {
                key: "order",
                type: "number",
                example: 1
            },
            probability: {
                key: "probability",
                type: "number",
                example: 0.5
            },
            leads: {
                key: "leads",
                type: "array",
                example: [
                    "0f9c0b0b4f0c6b0017f0e3b1",
                    "0f9c0b0b4f0c6b0017f0e3b2"
                ]
            },
            createdAt: {
                key: "createdAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            },
            updatedAt: {
                key: "updatedAt",
                type: "string",
                example: "2023-05-17T12:00:00Z"
            }
        }
    ],
    createdAt: "2023-05-17T12:00:00Z",
    updatedAt: "2023-05-17T12:00:00Z"
}

Lead

Campaign

support@fassport.co

Resources

Docs

Pricing

Roadmap

About

Integrations

Support

Sign-In

Sign-Up

Forgot Password

Contact

Schedule Demo

Pipeline

Get All

Get by id

Create

Update

Delete

Archive

Unarchive

Create Stage

Update Stage

Delete Stage

Add Lead to Stage

Remove Lead from Stage