Menu

Meetings

2 endpoints in the Mattering Sales API.

GETPOST meetings/ User APIService tier

List meetings, or create one with POST. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/meetings/
  • Service tierhttps://sales.mattering.io/api/internal/meetings/

Query parameters

NameDefault
sortnone
start_afternone
start_beforenone

Body keys (JSON)

KeyRequiredDefault
business_idoptional or conditionalnone
contact_idoptional or conditionalnone
descriptionoptional or conditionalnone
end_atoptional or conditionalnone
is_all_dayoptional or conditionalnone
locationoptional or conditionalnone
meeting_urloptional or conditionalnone
start_atoptional or conditionalnone
statusoptional or conditionalnone
titleoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Pagination

Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.

Responses

200 data and meta envelope

{
  "data": {
    "meetings": [
      {
        "...": "..."
      }
    ]
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "next_offset": 0
  }
}

201 data and meta envelope

{
  "data": {
    "meeting": {
      "...": "..."
    }
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "next_offset": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400anchor_mismatch
400invalid_json
400invalid_times
400missing_field
403unknown_actor
404business_not_found
404contact_not_found
409calendar_unavailable
502calendar_error

Example

curl -X POST "https://sales.mattering.io/api/user/v1/meetings/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "business_id": "...",
  "contact_id": "...",
  "description": "...",
  "end_at": "...",
  "is_all_day": "...",
  "location": "...",
  "meeting_url": "...",
  "start_at": "..."
}'

Source: CRMCore/timeline_api.py (timeline_api.meetings)

GETPATCHDELETE meetings/{booking_id}/ User APIService tier

Read, update or delete one of the meetings by id. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/meetings/{booking_id}/
  • Service tierhttps://sales.mattering.io/api/internal/meetings/{booking_id}/

Path parameters

NameType
booking_idstr

Query parameters

NameDefault
reasonnone

Body keys (JSON)

KeyRequiredDefault
business_idoptional or conditionalnone
contact_idoptional or conditionalnone
end_atoptional or conditionalnone
start_atoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 data and meta envelope

{
  "data": {
    "id": "...",
    "canceled": true
  }
}

200 data and meta envelope

{
  "data": {
    "meeting": {
      "...": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400anchor_mismatch
400invalid_json
400invalid_times
400missing_field
403unknown_actor
404business_not_found
404contact_not_found
404not_found
502calendar_error

Example

curl -X PATCH "https://sales.mattering.io/api/user/v1/meetings/BOOKING_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "business_id": "...",
  "contact_id": "...",
  "end_at": "...",
  "start_at": "..."
}'

Source: CRMCore/timeline_api.py (timeline_api.meeting_detail)

All Sales resources
Start Free Explore our Products