POST Create Contact

Base URLs

Demo URL: https://demoapi.openletterconnect.com/api/v1

Production URL: https://api.openletterconnect.com/api/v1

{{base_url}}/contacts

Description

This endpoint is used to create a new contact in the system. It allows you to add a contact's details, including the name, company, address, phone number, email, and tags. The API will return a confirmation message along with the created contact's information.

The isReturnAddress field indicates whether the provided address is a return address. This is used when you need to specify if the given address should be treated as a return address for shipments, correspondence, or returns. Set isReturnAddress to trueif the address is specifically used for returns; otherwise, you can set it to false or omit it. - Type: Boolean - Possible Values: true / false

AUTHORIZATION

Bearer Token

• Token: {{jwt_token}}

Body Raw

{
    "companyName": "ABCD",
    "firstName": "Alex",
    "lastName": "Brown",
    "address1": "1234 Random Street, Suite 567",
    "address2": "Springfield, IL 62704",
    "phoneNo": "217-555-1234",
    "extension": "123",
    "email": "[email protected]",
    "websiteUrl": "https://abcd.com",
    "city": "Springfield",
    "state": "Illinois",
    "countryCode": "US",
    "zip": "62704",
    "isVerified": true,
    "tags": [
        "office",
        "shop",
        "house"
    ],
    "customFields": {
        "Age": 20,
        "My_Wife_Name": "wife name is here"
    },
    "meta_data": {
        "account_id": "123-1234-12342355-12323534634"
    },
    "propertyAddress": "1712 Royalsborough Rd",
    "propertyCity": "Durham",
    "propertyState": "ME",
    "propertyZip": "04222",
    "isReturnAddress": true
}

Example Request

curl --location -g '{{base_url}}/contacts' \
--data-raw '{
    "companyName": "ABCD",
    "firstName": "Alex",
    "lastName": "Brown",
    "address1": "1234 Random Street, Suite 567",
    "address2": "Springfield, IL 62704",
    "phoneNo": "217-555-1234",
    "extension": "123",
    "email": "[email protected]",
    "websiteUrl": "https://abcd.com",
    "city": "Springfield",
    "state": "Illinois",
    "countryCode": "US",
    "zip": "62704",
    "isVerified": true,
    "meta": [],
    "tags": [
        "office",
        "shop",
        "house"
    ]
}'

Example Response

{
  "message": "Contact Created Successfully",
  "data": {
    "id": "5",
    "firstName": "Husnain",
    "lastName": "Arshad",
    "fullName": "Husnain Arshad",
    "companyName": "Invozone",
    "address1": "605 Abdul Haque Rd, Block H-3 Block H 3 Phase 2 Johar Town",
    "address2": "Lahore, Punjab 54000",
    "city": "Lahore",
    "state": "Punjab",
    "zip": "54000",
    "phoneNo": "0317 7711171",
    "extension": "042",
    "websiteUrl": "https://invozone.com",
    "addressStatus": null,
    "lastMailedStatus": null,
    "lastMailedDate": null,
    "orgId": "1",
    "email": "[email protected]",
    "isVerified": null,
    "isLiveMode": false,
    "ContactLabels": [
      {
        "id": "1",
        "title": "office"
      },
      {
        "id": "2",
        "title": "shop"
      },
      {
        "id": "3",
        "title": "house"
      }
    ],
    "createdAt": "2023-12-06T13:08:53.823Z"
  }
}