Add - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

leadId

string

required

type

enum<string>

required

Allowed values:

callmeetingemailtaskfollow-Upother

subject

string

required

date

string <date-time>

required

description

string | null

optional

assignedTo

string | null

optional

notes

string

optional

files

array[string]

optional

Example

{
    "leadId": "string",
    "type": "call",
    "subject": "string",
    "date": "2019-08-24T14:15:22Z",
    "description": "string",
    "assignedTo": "string",
    "notes": "string",
    "files": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/lead-activity' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "leadId": "string",
    "type": "call",
    "subject": "string",
    "date": "2019-08-24T14:15:22Z",
    "description": "string",
    "assignedTo": "string",
    "notes": "string",
    "files": [
        "string"
    ]
}'

Responses

🟢200Ok

application/json

Body

data

object (LeadActivityDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

lead

object (ICommonLead)

required

type

enum<string>

required

Allowed values:

callmeetingemailtaskfollow-Upother

subject

string

required

date

string <date-time>

required

description

string | null

optional

assignedTo

optional

createdBy

object (ICommonUser)

required

notes

string

optional

files

array[string]

optional

message

string

optional

Example

{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organizationId": "string",
        "lead": {
            "id": "string",
            "name": "string",
            "leadType": "business",
            "billingAddress": {
                "locationName": "string",
                "street1": "string",
                "street2": "string",
                "pincode": "string",
                "city": "string",
                "state": "string",
                "country": "string"
            },
            "contacts": [
                {
                    "isPrimary": true,
                    "salutation": "Mr.",
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "workPhone": "string",
                    "mobilePhone": "string",
                    "designation": "string",
                    "department": "string"
                }
            ],
            "shippingAddress": {
                "locationName": "string",
                "street1": "string",
                "street2": "string",
                "pincode": "string",
                "city": "string",
                "state": "string",
                "country": "string"
            }
        },
        "type": "call",
        "subject": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "assignedTo": {
            "id": "string",
            "name": "string",
            "email": "string",
            "organizations": [
                {
                    "organizationHashId": "string",
                    "organizationId": "string",
                    "role": "organization-admin",
                    "teams": [
                        "admin"
                    ],
                    "organizationName": "string",
                    "organizationLogo": "string",
                    "isActive": true
                }
            ]
        },
        "createdBy": {
            "id": "string",
            "name": "string",
            "email": "string",
            "organizations": [
                {
                    "organizationHashId": "string",
                    "organizationId": "string",
                    "role": "organization-admin",
                    "teams": [
                        "admin"
                    ],
                    "organizationName": "string",
                    "organizationLogo": "string",
                    "isActive": true
                }
            ]
        },
        "notes": "string",
        "files": [
            "string"
        ]
    },
    "message": "string"
}

🟢200Success