Back to explore

storage

Contacts

Credits: 0.000001

Create

POST /v1/contact/Create

Create a contact

Request

addressesarray

optional, location

birthdaystring

optional, birthday

emailsarray

optional, emails

linksarray

optional, links

namestring

required, the name of the contact

notestring

optional, note of the contact

phonesarray

optional, phone numbers

social_mediasarray

optional, social media

Response

contactobject

Request

Response

{
    "contact": {
        "id": "42e48a3c-6221-11ec-96d2-acde48001122",
        "name": "joe",
        "phones": [
            {
                "label": "home",
                "number": "010-12345678"
            },
            {
                "label": "work",
                "number": "010-87654321"
            }
        ],
        "emails": [
            {
                "label": "home",
                "address": "[email protected]"
            },
            {
                "label": "work",
                "address": "[email protected]"
            }
        ],
        "links": [
            {
                "label": "blog",
                "url": "https://blog.joe.me"
            }
        ],
        "birthday": "1995-01-01",
        "addresses": [
            {
                "label": "company address",
                "location": "123 street address"
            }
        ],
        "social_medias": [
            {
                "label": "twitter",
                "username": "joe-twitter"
            },
            {
                "label": "facebook",
                "username": "joe-facebook"
            }
        ],
        "note": "this person is very important",
        "created_at": "2021-12-21T17:28:15+08:00",
        "updated_at": "2021-12-21T17:31:21+08:00"
    }
}

Credits: 0.000001

Delete

POST /v1/contact/Delete

Delete a contact

Request

idstring

the id of the contact

Response

{}

Request

Response

{}

Credits: 0.000001

List

POST /v1/contact/List

List contacts

Request

limitnumber

optional, default is 30

offsetnumber

optional

Response

contactsarray

Request

Response

{
    "contacts": [
        {
            "id": "7765a308-6222-11ec-96d2-acde48001122",
            "name": "contact-1",
            "phones": [
                {
                    "label": "home",
                    "number": "010-1234567"
                }
            ],
            "emails": [],
            "links": [],
            "birthday": "",
            "addresses": [],
            "social_medias": [],
            "note": "",
            "created_at": "2021-12-21T17:28:15+08:00",
            "updated_at": "2021-12-21T17:31:21+08:00"
        },
        {
            "id": "7a7c1806-6222-11ec-96d2-acde48001122",
            "name": "contact-2",
            "phones": [
                {
                    "label": "home",
                    "number": "010-1234567"
                }
            ],
            "emails": [],
            "links": [],
            "birthday": "",
            "addresses": [],
            "social_medias": [],
            "note": "",
            "created_at": "2021-12-21T17:28:15+08:00",
            "updated_at": "2021-12-21T17:31:21+08:00"
        },
        {
            "id": "7d4a8e28-6222-11ec-96d2-acde48001122",
            "name": "contact-3",
            "phones": [
                {
                    "label": "home",
                    "number": "010-1234567"
                }
            ],
            "emails": [],
            "links": [],
            "birthday": "",
            "addresses": [],
            "social_medias": [],
            "note": "",
            "created_at": "2021-12-21T17:28:15+08:00",
            "updated_at": "2021-12-21T17:31:21+08:00"
        }
    ]
}

Credits: 0.000001

Read

POST /v1/contact/Read

Read contact details

Request

idstring

Response

contactobject

Request

Response

{
    "contact": {
        "id": "42e48a3c-6221-11ec-96d2-acde48001122",
        "name": "joe",
        "phones": [
            {
                "label": "home",
                "number": "010-12345678"
            },
            {
                "label": "work",
                "number": "010-87654321"
            }
        ],
        "emails": [
            {
                "label": "home",
                "address": "[email protected]"
            },
            {
                "label": "work",
                "address": "[email protected]"
            }
        ],
        "links": [
            {
                "label": "blog",
                "url": "https://blog.joe.me"
            }
        ],
        "birthday": "1995-01-01",
        "addresses": [
            {
                "label": "company address",
                "location": "123 street address"
            }
        ],
        "social_medias": [
            {
                "label": "twitter",
                "username": "joe-twitter"
            },
            {
                "label": "facebook",
                "username": "joe-facebook"
            }
        ],
        "note": "this person is very important",
        "created_at": "2021-12-21T17:28:15+08:00",
        "updated_at": "2021-12-21T17:31:21+08:00"
    }
}

Credits: 0.000001

Update

POST /v1/contact/Update

Update a contact

Request

addressesarray

optional, addresses

birthdaystring

optional, birthday

emailsarray

optional, emails

idstring

required, the contact id

linksarray

optional, links

namestring

required, the name

notestring

optional, note

phonesarray

optional, phone number

social_mediasarray

optional, social media

Response

contactobject

Request

Response

{
    "contact": {
        "id": "42e48a3c-6221-11ec-96d2-acde48001122",
        "name": "joe",
        "phones": [
            {
                "label": "home",
                "number": "010-12345678"
            },
            {
                "label": "work",
                "number": "010-87654321"
            }
        ],
        "emails": [
            {
                "label": "home",
                "address": "[email protected]"
            },
            {
                "label": "work",
                "address": "[email protected]"
            }
        ],
        "links": [
            {
                "label": "blog",
                "url": "https://blog.joe.me"
            }
        ],
        "birthday": "1995-01-01",
        "addresses": [
            {
                "label": "company address",
                "location": "123 street address"
            }
        ],
        "social_medias": [
            {
                "label": "twitter",
                "username": "joe-twitter"
            },
            {
                "label": "facebook",
                "username": "joe-facebook"
            }
        ],
        "note": "this person is very important",
        "created_at": "2021-12-21T17:28:15+08:00",
        "updated_at": "2021-12-21T17:31:21+08:00"
    }
}