📧Email address

Search email

GET https://{API_DOMAIN}/api/v1/email-contact

curl -X GET
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/email-contact?contact_id=1"

Query Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
page	false	1	Number	Which page is currently on
per_page	false	15	Number	How many items to display per page
contact_id	false	NULL	Number	Customer id
name	false	NULL	String	Defined Email name
description	false	NULL	String	Email note
address	false	NULL	String	Email address

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Email array
meta	Object	Pagination meta

{
    "data": [
        {
            "id": 1,
            "address": "[email protected]",
            "contact_id": 1,
            "draft": null,
            "name": "Jaiden Champlin III",
            "description": "Pariatur dolorem aut voluptatibus. Aut pariatur voluptatum ratione atque sit. Et inventore quo voluptates animi.",
            "contact": {
                "id": 1,
                "membership_no": "8771639",
                "identity_no": "418099",
                "first_name": "Angelita",
                "last_name": "D'Amore",
                "gender": 0,
                "birth_at": "1985-08-27 00:00:00",
                "created_at": "2019-04-10 03:01:41",
                "updated_at": "2019-04-10 03:01:41",
                "profile_id": 1,
                "sponsor_id": null,
                "disturb_setting": null
            }
        },
        {
            "id": 5,
            "address": "[email protected]",
            "contact_id": 1,
            "draft": null,
            "name": "Mikayla Funk",
            "description": "Possimus optio molestiae perspiciatis distinctio. Vel incidunt ut unde. Laudantium eaque distinctio officia eum error odit.",
            "contact": {
                "id": 1,
                "membership_no": "8771639",
                "identity_no": "418099",
                "first_name": "Angelita",
                "last_name": "D'Amore",
                "gender": 0,
                "birth_at": "1985-08-27 00:00:00",
                "created_at": "2019-04-10 03:01:41",
                "updated_at": "2019-04-10 03:01:41",
                "profile_id": 1,
                "sponsor_id": null,
                "disturb_setting": null
            }
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}

Get specified email

https://{API_DOMAIN}/api/v1/email-contact/{email_contact}

curl -X GET
    -H "Content-Type: application/json"
    https://{API_HOST}/api/v1/email-contact/1

PROPERTY	TYPE	DESCRIPTION
data	Object	Email

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
email_contact	True	Null	Number	Emailid of

Response

Please refer toEmailResponse format

{
    "data": {
        "id": 1,
        "address": "[email protected]",
        "contact_id": 1,
        "draft": null,
        "name": "Jaiden Champlin III",
        "description": "Pariatur dolorem aut voluptatibus. Aut pariatur voluptatum ratione atque sit. Et inventore quo voluptates animi.",
        "contact": {
            "id": 1,
            "membership_no": "8771639",
            "identity_no": "418099",
            "first_name": "Angelita",
            "last_name": "D'Amore",
            "gender": 0,
            "birth_at": "1985-08-27 00:00:00",
            "created_at": "2019-04-10 03:01:41",
            "updated_at": "2019-04-10 03:01:41",
            "profile_id": 1,
            "sponsor_id": null,
            "disturb_setting": null
        }
    }
}

Add email

Add email for specified customer

POST https://{API_DOMAIN}/api/v1/email-contact

curl -X POST
    -H "Content-Type: application/json"
    '{"contact_id":1,"address":"[email protected]","name":"Theresia Zieme"}'
    https://{API_HOST}/api/v1/email-contact

Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact_id	true	NULL	Number	Customer id
address	true	NULL	String	Email address
name	false	NULL	String	Custom email name
description	false	NULL	String	Custom email description

Response

Please refer toEmailResponse format

{
    "data": {
        "id": 3,
        "address": "[email protected]",
        "contact_id": 1,
        "draft": null,
        "name": "Theresia Zieme",
        "description": null,
        "contact": {
            "id": 1,
            "membership_no": "8771639",
            "identity_no": "418099",
            "first_name": "Angelita",
            "last_name": "D'Amore",
            "gender": 0,
            "birth_at": "1985-08-27 00:00:00",
            "created_at": "2019-04-10 03:01:41",
            "updated_at": "2019-04-10 03:01:41",
            "profile_id": 1,
            "sponsor_id": null,
            "disturb_setting": null
        }
    }
}

Update specified email

PUT https://{API_DOMAIN}/api/v1/email-contact/{email_contact}

curl -X PUT
    -H "Content-Type: application/json"
    '{"name":"Sharon"}'
    https://{API_HOST}/api/v1/email-contact/1

Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
address	true	NULL	String	Email address
name	false	NULL	String	Custom email name
description	false	NULL	String	Custom email description

Response

Please refer toEmailResponse format

{
    "data": {
        "id": 3,
        "address": "[email protected]",
        "contact_id": 1,
        "draft": null,
        "name": "Sharon",
        "description": null,
        "contact": {
            "id": 1,
            "membership_no": "8771639",
            "identity_no": "418099",
            "first_name": "Angelita",
            "last_name": "D'Amore",
            "gender": 0,
            "birth_at": "1985-08-27 00:00:00",
            "created_at": "2019-04-10 03:01:41",
            "updated_at": "2019-11-10 03:01:41",
            "profile_id": 1,
            "sponsor_id": null,
            "disturb_setting": null
        }
    }
}

Delete email

Http status is 204

https://{API_DOMAIN}/api/v1/email-contact/{email_contact}

curl -X DELETE
    -H "Content-Type: application/json"
    "https://{API_HOST}/api/v1/email-contact?contact_id=1"

URL Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
email_contact	true	NULL	Number	Email id

{}