Create Contact

POST 
https://api.tinyemail.com/v1/contacts

Create a new contact list with members in it

Request

application/json

Body

required

name stringrequired
members object[]
Array [
email stringrequired
firstName string
lastName string
source string
birthday string
tags string[]
currency string
country string
province string
city string
address1 string
address2 string
phone string
postalCode string
company string
lastPurchaseOrder string
lastPurchasePrice string
latestOrderId string
]

Responses

200

Successful operation

application/json

Schema

Schema

id uuid

Example (from schema)

{
  "id": "00000000-0000-0000-0000-000000000000"
}

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyin: headerdescription: To obtain API-KEY, please contact our customer support by email support@tinyemail.com or directly by chat.

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.tinyemail.com/v1/contacts' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>' \
--data-raw '{
  "name": "my contacts",
  "members": [
    {
      "email": "test@tinyemail.com",
      "firstName": "John",
      "lastName": "Doe",
      "source": "sales_force",
      "birthday": "04/23/1946",
      "tags": [
        "string"
      ],
      "currency": "SOS",
      "country": "Argentina",
      "province": "Massachusetts",
      "city": "Burnsville",
      "address1": "31641 Candace Locks",
      "address2": "Apt. 452",
      "phone": "(123) 456-7890",
      "postalCode": "87774",
      "company": "Bode Inc",
      "lastPurchaseOrder": "Super Bike",
      "lastPurchasePrice": "3500",
      "latestOrderId": "Order#50993961"
    }
  ]
}'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Body required

{
  "name": "my contacts",
  "members": [
    {
      "email": "test@tinyemail.com",
      "firstName": "John",
      "lastName": "Doe",
      "source": "sales_force",
      "birthday": "04/23/1946",
      "tags": [
        "string"
      ],
      "currency": "SOS",
      "country": "Argentina",
      "province": "Massachusetts",
      "city": "Burnsville",
      "address1": "31641 Candace Locks",
      "address2": "Apt. 452",
      "phone": "(123) 456-7890",
      "postalCode": "87774",
      "company": "Bode Inc",
      "lastPurchaseOrder": "Super Bike",
      "lastPurchasePrice": "3500",
      "latestOrderId": "Order#50993961"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!