Skip to content

contacts

Contacts

Bases: ListableApiResource, FindableApiResource, CreatableApiResource, UpdatableApiResource, DestroyableApiResource

Nylas Contacts API

The Contacts API allows you to manage contacts and contact groups for a user.

Source code in nylas/resources/contacts.py 
 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
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
class Contacts(
    ListableApiResource,
    FindableApiResource,
    CreatableApiResource,
    UpdatableApiResource,
    DestroyableApiResource,
):
    """
    Nylas Contacts API

    The Contacts API allows you to manage contacts and contact groups for a user.
    """

    def list(
        self,
        identifier: str,
        query_params: ListContactsQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[Contact]:
        """
        Return all Contacts.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The list of contacts.
        """

        return super().list(
            path=f"/v3/grants/{identifier}/contacts",
            query_params=query_params,
            response_type=Contact,
            overrides=overrides,
        )

    def find(
        self,
        identifier: str,
        contact_id: str,
        query_params: FindContactQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> Response[Contact]:
        """
        Return a Contact.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            contact_id: The ID of the contact to retrieve.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The contact.
        """
        return super().find(
            path=f"/v3/grants/{identifier}/contacts/{contact_id}",
            response_type=Contact,
            query_params=query_params,
            overrides=overrides,
        )

    def create(
        self,
        identifier: str,
        request_body: CreateContactRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Contact]:
        """
        Create a Contact.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            request_body: The values to create the Contact with.
            overrides: The request overrides to use for the request.

        Returns:
            The created contact.
        """
        return super().create(
            path=f"/v3/grants/{identifier}/contacts",
            response_type=Contact,
            request_body=request_body,
            overrides=overrides,
        )

    def update(
        self,
        identifier: str,
        contact_id: str,
        request_body: UpdateContactRequest,
        overrides: RequestOverrides = None,
    ) -> Response[Contact]:
        """
        Update a Contact.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            contact_id: The ID of the Contact to update.
                Use "primary" to refer to the primary Contact associated with the Grant.
            request_body: The values to update the Contact with.
            overrides: The request overrides to use for the request.

        Returns:
            The updated contact.
        """
        return super().update(
            path=f"/v3/grants/{identifier}/contacts/{contact_id}",
            response_type=Contact,
            request_body=request_body,
            overrides=overrides,
        )

    def destroy(
        self,
        identifier: str,
        contact_id: str,
        overrides: RequestOverrides = None,
    ) -> DeleteResponse:
        """
        Delete a Contact.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            contact_id: The ID of the Contact to delete.
                Use "primary" to refer to the primary Contact associated with the Grant.
            overrides: The request overrides to use for the request.

        Returns:
            The deletion response.
        """
        return super().destroy(
            path=f"/v3/grants/{identifier}/contacts/{contact_id}", overrides=overrides
        )

    def list_groups(
        self,
        identifier: str,
        query_params: ListContactGroupsQueryParams = None,
        overrides: RequestOverrides = None,
    ) -> ListResponse[ContactGroup]:
        """
        Return all contact groups.

        Attributes:
            identifier: The identifier of the Grant to act upon.
            query_params: The query parameters to include in the request.
            overrides: The request overrides to use for the request.

        Returns:
            The list of contact groups.
        """
        json_response = self._http_client._execute(
            method="GET",
            path=f"/v3/grants/{identifier}/contacts/groups",
            query_params=query_params,
            overrides=overrides,
        )

        return ListResponse.from_dict(json_response, ContactGroup)

create(identifier, request_body, overrides=None)

Create a Contact.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
request_body

The values to create the Contact with.
overrides

The request overrides to use for the request.

Returns:

Type Description
Response[Contact]

The created contact.
Source code in nylas/resources/contacts.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def create(
    self,
    identifier: str,
    request_body: CreateContactRequest,
    overrides: RequestOverrides = None,
) -> Response[Contact]:
    """
    Create a Contact.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        request_body: The values to create the Contact with.
        overrides: The request overrides to use for the request.

    Returns:
        The created contact.
    """
    return super().create(
        path=f"/v3/grants/{identifier}/contacts",
        response_type=Contact,
        request_body=request_body,
        overrides=overrides,
    )

destroy(identifier, contact_id, overrides=None)

Delete a Contact.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
contact_id

The ID of the Contact to delete. Use "primary" to refer to the primary Contact associated with the Grant.
overrides

The request overrides to use for the request.

Returns:

Type Description
DeleteResponse

The deletion response.
Source code in nylas/resources/contacts.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def destroy(
    self,
    identifier: str,
    contact_id: str,
    overrides: RequestOverrides = None,
) -> DeleteResponse:
    """
    Delete a Contact.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        contact_id: The ID of the Contact to delete.
            Use "primary" to refer to the primary Contact associated with the Grant.
        overrides: The request overrides to use for the request.

    Returns:
        The deletion response.
    """
    return super().destroy(
        path=f"/v3/grants/{identifier}/contacts/{contact_id}", overrides=overrides
    )

find(identifier, contact_id, query_params=None, overrides=None)

Return a Contact.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
contact_id

The ID of the contact to retrieve.
query_params

The query parameters to include in the request.
overrides

The request overrides to use for the request.

Returns:

Type Description
Response[Contact]

The contact.
Source code in nylas/resources/contacts.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def find(
    self,
    identifier: str,
    contact_id: str,
    query_params: FindContactQueryParams = None,
    overrides: RequestOverrides = None,
) -> Response[Contact]:
    """
    Return a Contact.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        contact_id: The ID of the contact to retrieve.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The contact.
    """
    return super().find(
        path=f"/v3/grants/{identifier}/contacts/{contact_id}",
        response_type=Contact,
        query_params=query_params,
        overrides=overrides,
    )

list(identifier, query_params=None, overrides=None)

Return all Contacts.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
query_params

The query parameters to include in the request.
overrides

The request overrides to use for the request.

Returns:

Type Description
ListResponse[Contact]

The list of contacts.
Source code in nylas/resources/contacts.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def list(
    self,
    identifier: str,
    query_params: ListContactsQueryParams = None,
    overrides: RequestOverrides = None,
) -> ListResponse[Contact]:
    """
    Return all Contacts.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The list of contacts.
    """

    return super().list(
        path=f"/v3/grants/{identifier}/contacts",
        query_params=query_params,
        response_type=Contact,
        overrides=overrides,
    )

list_groups(identifier, query_params=None, overrides=None)

Return all contact groups.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
query_params

The query parameters to include in the request.
overrides

The request overrides to use for the request.

Returns:

Type Description
ListResponse[ContactGroup]

The list of contact groups.
Source code in nylas/resources/contacts.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def list_groups(
    self,
    identifier: str,
    query_params: ListContactGroupsQueryParams = None,
    overrides: RequestOverrides = None,
) -> ListResponse[ContactGroup]:
    """
    Return all contact groups.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        query_params: The query parameters to include in the request.
        overrides: The request overrides to use for the request.

    Returns:
        The list of contact groups.
    """
    json_response = self._http_client._execute(
        method="GET",
        path=f"/v3/grants/{identifier}/contacts/groups",
        query_params=query_params,
        overrides=overrides,
    )

    return ListResponse.from_dict(json_response, ContactGroup)

update(identifier, contact_id, request_body, overrides=None)

Update a Contact.

Attributes:

Name Type Description
identifier

The identifier of the Grant to act upon.
contact_id

The ID of the Contact to update. Use "primary" to refer to the primary Contact associated with the Grant.
request_body

The values to update the Contact with.
overrides

The request overrides to use for the request.

Returns:

Type Description
Response[Contact]

The updated contact.
Source code in nylas/resources/contacts.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def update(
    self,
    identifier: str,
    contact_id: str,
    request_body: UpdateContactRequest,
    overrides: RequestOverrides = None,
) -> Response[Contact]:
    """
    Update a Contact.

    Attributes:
        identifier: The identifier of the Grant to act upon.
        contact_id: The ID of the Contact to update.
            Use "primary" to refer to the primary Contact associated with the Grant.
        request_body: The values to update the Contact with.
        overrides: The request overrides to use for the request.

    Returns:
        The updated contact.
    """
    return super().update(
        path=f"/v3/grants/{identifier}/contacts/{contact_id}",
        response_type=Contact,
        request_body=request_body,
        overrides=overrides,
    )