POST
/
meetings
curl --request POST \
  --url https://commerce.driv.ly/api/meetings \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "met_3kd93d3j93d2",
  "time": "2024-03-12T10:00:00Z",
  "note": "Discuss annual contract terms",
  "email": "contact@email.com",
  "salesRep": {
    "id": "rep_3kd93d3j93d2",
    "emails": [
      "rep@email.com"
    ],
    "lastName": "Smith",
    "firstName": "John",
    "templates": [
      "Template ID"
    ],
    "creditBands": [
      "Good",
      "Excellent"
    ],
    "primaryEmail": "rep@email.com",
    "phoneNumbers": [
      "555-0182"
    ],
    "primaryPhoneNumber": "555-0182",
    "isAcceptingNewLeads": true
  },
  "phoneNumber": "555-0192"
}'
{
  "data": {
    "id": "met_3kd93d3j93d2",
    "time": "2024-03-12T10:00:00Z",
    "note": "Discuss annual contract terms",
    "email": "contact@email.com",
    "salesRep": {
      "id": "rep_3kd93d3j93d2",
      "emails": [
        "rep@email.com"
      ],
      "lastName": "Smith",
      "firstName": "John",
      "templates": [
        "Template ID"
      ],
      "creditBands": [
        "Good",
        "Excellent"
      ],
      "primaryEmail": "rep@email.com",
      "phoneNumbers": [
        "555-0182"
      ],
      "primaryPhoneNumber": "555-0182",
      "isAcceptingNewLeads": true
    },
    "phoneNumber": "555-0192"
  },
  "success": true
}

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
phoneNumber
string
required

Phone Number is left for Meeting

email
string
required

Email is left for Meeting

time
string
required

Meeting is scheduled for Time

salesRep
required

Meeting is with Sales Rep

id
string

Meeting is uniquely identified by id

note
string

Meeting has Note

Response

200
application/json
Meeting Created
data
object
Example:
{
  "id": "met_3kd93d3j93d2",
  "time": "2024-03-12T10:00:00Z",
  "note": "Discuss annual contract terms",
  "email": "contact@email.com",
  "salesRep": {
    "id": "rep_3kd93d3j93d2",
    "emails": ["rep@email.com"],
    "lastName": "Smith",
    "firstName": "John",
    "templates": ["Template ID"],
    "creditBands": ["Good", "Excellent"],
    "primaryEmail": "rep@email.com",
    "phoneNumbers": ["555-0182"],
    "primaryPhoneNumber": "555-0182",
    "isAcceptingNewLeads": true
  },
  "phoneNumber": "555-0192"
}
success
boolean