Skip to main content
POST
/
contacts
Create a contact
curl --request POST \
  --url https://api.smokeball.com/contacts \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "externalSystemId": "EXT01",
  "person": {
    "title": "Mr",
    "firstName": "John",
    "middleName": "Michael",
    "lastName": "Smith",
    "nameSuffix": "PhD",
    "customName": "Johnny",
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "phone2": {
      "areaCode": "555",
      "number": "1234567",
      "extension": "103"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "cell": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "john.smith@brown.com",
    "notes": "Prefers to answer work phone.",
    "occupation": "Bookkeeper",
    "birthDate": "1980-07-01",
    "birthPlace": "Chicago",
    "birthState": "Illinois",
    "birthCountry": "Australia",
    "identificationNumberType": "SSN",
    "identificationNumber": "PP123456789",
    "passportDetails": {
      "passportNumber": "AB123456",
      "passportIssueDate": "2010-08-01",
      "passportExpireDate": "2030-08-01",
      "passportIssueCountry": "USA",
      "passportIssueAuthority": "HM Passport Office"
    },
    "deathDetails": {
      "deathDate": "2020-08-01",
      "isDeathDateUnknown": false,
      "deathDateFrom": "2020-08-01",
      "deathDateTo": "2020-08-01",
      "deathPlace": "Chicago",
      "deathState": "IL",
      "deathCountry": "USA",
      "deathCounty": "San Bernardino County"
    },
    "gender": "Male",
    "maritalStatus": "Single",
    "specialNeeds": "Wheelchair access",
    "birthFirstName": "James",
    "birthMiddleName": "Thomas",
    "birthLastName": "Jones",
    "previousNames": "Jane Smith",
    "correctionsReferenceNumber": "<string>",
    "centrelinkReferenceNumber": "<string>",
    "identificationDetails": {
      "alienNumber": "<string>",
      "registrationAuthority": "<string>",
      "registrationNumber": "<string>",
      "driversLicenseNumber": "<string>",
      "driversLicenseState": "<string>",
      "medicareNumber": "<string>"
    },
    "citizenshipDetails": {
      "countryOfCitizenship": "USA",
      "nationality": "American",
      "languageOfInterpreter": "French"
    },
    "utbmsDetails": {
      "ledesClientId": "<string>"
    }
  },
  "company": {
    "name": "Brown LLC",
    "type": "Corporation",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "contact@brown.com",
    "notes": "Recently merged with Cyberdyne Inc.",
    "businessAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      },
      "dxAddress": {
        "number": "<string>",
        "exchange": "<string>",
        "state": "<string>"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "abn": "1234567890",
    "companyNumberType": "ACN",
    "companyNumber": "234567890",
    "staffIds": [
      "73481c13-b7f8-4610-b221-aaccbf7aaade",
      "18cd6029-4a9e-4b99-bae5-710a7d79a19b"
    ],
    "directorIds": [
      "73481c13-b7f8-4610-b221-aaccbf7aaade",
      "18cd6029-4a9e-4b99-bae5-710a7d79a19b"
    ]
  },
  "trust": {
    "name": "Trinity Trust",
    "status": "as Trustee of",
    "trustNumber": "12345678",
    "executedDate": "1980-07-01",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "fax": {
      "areaCode": "555",
      "number": "1234567"
    },
    "address": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "trustees": [
      {
        "Name": "John Smith",
        "Type": "Individual"
      },
      {
        "Name": "Smithfield Steel",
        "Type": "Company"
      }
    ]
  },
  "groupOfPeople": {
    "peopleIds": [
      "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
    ],
    "residentialAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    },
    "mailingAddress": {
      "careOf": "John Smith",
      "buildingLevel": "Level 1",
      "unitNumber": "10",
      "unitType": "Suite",
      "streetNumber": "100",
      "streetName": "Broad",
      "streetType": "Street",
      "addressLine1": "Level 1/10",
      "addressLine2": "100 Broad Street",
      "city": "Chicago",
      "state": "IL",
      "zipCode": "60606",
      "locality": "Dunkirk",
      "county": "New York",
      "country": "United States",
      "poBox": {
        "careOf": "John Smith",
        "poBoxType": "Locked Bag",
        "poBoxNumber": "12345",
        "city": "Chicago",
        "state": "IL",
        "zipCode": "60606"
      }
    }
  },
  "isDeleted": false
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Body

externalSystemId
string | null

External system id for the contact.

Example:

"EXT01"

person
object

Contact person details (if applicable).

company
object

Contact company details (if applicable).

trust
object

Contact trust details (if applicable).

Only supported in US.

groupOfPeople
object

Contact group details (if applicable).

Only supported in US and AU.

isDeleted
boolean

Contact can be restored by setting this to false.

Example:

false

Response

When request is accepted. Returns a 'Link' object.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
I