Records

Create a new record

Changed on

Creates a new record for a specific object type with the provided attributes

post/v1/objects/{slug}

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Path parameters

slugstring required

Object slug (e.g., 'person', 'company')

Request body

Example request

{
  "attributes": {
    "name": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "name (alternative)": "John Doe",
    "email_addresses": [
      "john@example.com"
    ],
    "phone_number": {
      "country_code": 1,
      "number": "5551234567"
    },
    "job_title": "Software Engineer",
    "location": {
      "street": "123 Main St",
      "city": "Boston",
      "region": "MA",
      "postal_code": "02134",
      "country": "US"
    }
  }
}

Response

Created record with all attributes

attributesobject
created_atstring
idstring
object_idstring
typestring
updated_atstring
workspace_idstring

Example response

{
  "id": "32710180831586561",
  "object_id": "32710180831586560",
  "type": "person",
  "workspace_id": "32710180831586559",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "attributes": {
    "name": {
      "first_name": "John",
      "last_name": "Doe"
    },
    "email_addresses": [
      "john@example.com"
    ],
    "phone_number": {
      "country_code": 1,
      "number": "5551234567"
    },
    "job_title": "Software Engineer",
    "location": {
      "street": "123 Main St",
      "city": "Boston",
      "region": "MA",
      "postal_code": "02134",
      "country": "US"
    }
  }
}

Changes