Skip to content
This repository has been archived by the owner on Aug 20, 2020. It is now read-only.

Latest commit

 

History

History
420 lines (349 loc) · 9.34 KB

USE_CASES.md

File metadata and controls

420 lines (349 loc) · 9.34 KB
Raw

Following Document provides several use cases of how to make RESTful method calls for an http-client. Please open an issue or make a pull request for any use cases you would like us to document here. Thank you!

RESTful API Calls-

  • GET
  • POST
  • PATCH
  • PUT
  • DEL

In the following examples, it assumed you have got your own unique Sendgrid API key.

The Following Requests are made using Python.

Please Import these libraries at the start of the program and install them using pip command if not already done before.

import sendgrid
import json
import os

Use your unique API key to complete the final setup for making calls.

sg = sendgrid.SendGridAPIClient(apikey=os.environ.get('SENDGRID_API_KEY'))

GET Requests

Retrieve all custom fields

GET /contactdb/custom_fields
response = sg.client.contactdb.custom_fields.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve a Custom Field

GET /contactdb/custom_fields/{custom_field_id}
custom_field_id = "test_url_param"
response = sg.client.contactdb.custom_fields._(custom_field_id).get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve all lists

GET /contactdb/lists
response = sg.client.contactdb.lists.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve all recipients on a List

GET /contactdb/lists/{list_id}/recipients
params = {'page': 1, 'page_size': 1}
list_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).recipients.get(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve recipients

GET /contactdb/recipients
params = {'page': 1, 'page_size': 1}
response = sg.client.contactdb.recipients.get(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve the count of billable recipients

GET /contactdb/recipients/billable_count
response = sg.client.contactdb.recipients.billable_count.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve a Count of Recipients

GET /contactdb/recipients/count
response = sg.client.contactdb.recipients.count.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve recipients matching search criteria

GET /contactdb/recipients/search
params = {'{field_name}': 'test_string'}
response = sg.client.contactdb.recipients.search.get(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve a single recipient

GET /contactdb/recipients/{recipient_id}
recipient_id = "test_url_param"
response = sg.client.contactdb.recipients._(recipient_id).get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve the lists that a recipient is on

GET /contactdb/recipients/{recipient_id}/lists
recipient_id = "test_url_param"
response = sg.client.contactdb.recipients._(recipient_id).lists.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve reserved fields

GET /contactdb/reserved_fields
response = sg.client.contactdb.reserved_fields.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve all segments

GET /contactdb/segments
response = sg.client.contactdb.segments.get()
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve a segment

GET /contactdb/segments/{segment_id}
params = {'segment_id': 1}
segment_id = "test_url_param"
response = sg.client.contactdb.segments._(segment_id).get(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Retrieve recipients on a segment

GET /contactdb/segments/{segment_id}/recipients
params = {'page': 1, 'page_size': 1}
segment_id = "test_url_param"
response = sg.client.contactdb.segments._(segment_id).recipients.get(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

POST Requests

Create a Custom Field

POST /contactdb/custom_fields
data = {
  "name": "pet", 
  "type": "text"
}
response = sg.client.contactdb.custom_fields.post(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Create a List

POST /contactdb/lists
data = {
  "name": "your list name"
}
response = sg.client.contactdb.lists.post(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Add a Single Recipient to a List

POST /contactdb/lists/{list_id}/recipients/{recipient_id}
list_id = "test_url_param"
recipient_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).post()
print(response.status_code)
print(response.body)
print(response.headers)

Add Multiple Recipients to a List

POST /contactdb/lists/{list_id}/recipients
data = [
  "recipient_id1", 
  "recipient_id2"
]
list_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).recipients.post(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Create a Segment

POST /contactdb/segments
data = {
  "conditions": [
    {
      "and_or": "", 
      "field": "last_name", 
      "operator": "eq", 
      "value": "Miller"
    }, 
    {
      "and_or": "and", 
      "field": "last_clicked", 
      "operator": "gt", 
      "value": "01/02/2015"
    }, 
    {
      "and_or": "or", 
      "field": "clicks.campaign_identifier", 
      "operator": "eq", 
      "value": "513"
    }
  ], 
  "list_id": 4, 
  "name": "Last Name Miller"
}
response = sg.client.contactdb.segments.post(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

PATCH Request

Update a List

PATCH /contactdb/lists/{list_id}
data = {
  "name": "newlistname"
}
params = {'list_id': 1}
list_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).patch(request_body=data, query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Update Recipient

PATCH /contactdb/recipients
data = [
  {
    "email": "[email protected]", 
    "first_name": "Guy", 
    "last_name": "Jones"
  }
]
response = sg.client.contactdb.recipients.patch(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Update a segment

PATCH /contactdb/segments/{segment_id}
data = {
  "conditions": [
    {
      "and_or": "", 
      "field": "last_name", 
      "operator": "eq", 
      "value": "Miller"
    }
  ], 
  "list_id": 5, 
  "name": "The Millers"
}
params = {'segment_id': 'test_string'}
segment_id = "test_url_param"
response = sg.client.contactdb.segments._(segment_id).patch(request_body=data, query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

DELETE Request

Delete a Custom Field

DELETE /contactdb/custom_fields/{custom_field_id}
custom_field_id = "test_url_param"
response = sg.client.contactdb.custom_fields._(custom_field_id).delete()
print(response.status_code)
print(response.body)
print(response.headers)

Delete a List

DELETE /contactdb/lists/{list_id}
params = {'delete_contacts': 'true'}
list_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).delete(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Delete Multiple lists

DELETE /contactdb/lists
data = [
  1, 
  2, 
  3, 
  4
]
response = sg.client.contactdb.lists.delete(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Delete Recipient

DELETE /contactdb/recipients
data = [
  "recipient_id1", 
  "recipient_id2"
]
response = sg.client.contactdb.recipients.delete(request_body=data)
print(response.status_code)
print(response.body)
print(response.headers)

Delete a Recipient

DELETE /contactdb/recipients/{recipient_id}
recipient_id = "test_url_param"
response = sg.client.contactdb.recipients._(recipient_id).delete()
print(response.status_code)
print(response.body)
print(response.headers)

Delete a Single Recipient from a Single List

DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}
params = {'recipient_id': 1, 'list_id': 1}
list_id = "test_url_param"
recipient_id = "test_url_param"
response = sg.client.contactdb.lists._(list_id).recipients._(recipient_id).delete(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)

Delete a segment

DELETE /contactdb/segments/{segment_id}
params = {'delete_contacts': 'true'}
segment_id = "test_url_param"
response = sg.client.contactdb.segments._(segment_id).delete(query_params=params)
print(response.status_code)
print(response.body)
print(response.headers)