Mobly REST API
Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault:
20offsetintegerOptionalDefault:
0Responses
200
Events list.
application/json
statusintegerRequiredExample:
200400
Bad request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
429
Too Many Requests
application/json
500
Internal server error
application/json
get/events
Authorizations
x-api-keystringRequired
Body
eventNamestringRequired
eventTypestring · enumRequiredPossible values:
Event type classification.
startDatestring · dateRequired
endDatestring · dateRequired
createdByEmailstring · emailRequired
registrationEnabledbooleanOptional
Responses
200
Created event.
application/json
statusintegerRequiredExample:
200400
Bad request
application/json
401
Unauthorized
application/json
post/events
Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired
Event ID
Body
eventNamestringRequired
eventTypestring · enumRequiredPossible values:
Event type classification.
startDatestring · dateRequired
endDatestring · dateRequired
registrationEnabledbooleanOptional
Responses
200
Updated event.
application/json
statusintegerRequiredExample:
200404
Event not found
application/json
put/events/{eventId}
Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired
Event ID
Query parameters
limitinteger · max: 50OptionalDefault:
20offsetintegerOptionalDefault:
0Responses
200
Event leads list.
application/json
statusintegerRequiredExample:
200get/events/{eventId}/leads
200
Event leads list.
Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired
Event ID
leadIdstringRequired
Lead ID
Responses
200
Association removed.
application/json
statusintegerRequiredExample:
200resultsobjectRequired
delete/events/{eventId}/leads/{leadId}
200
Association removed.
Authorizations
x-api-keystringRequired
Path parameters
eventIdintegerRequired
Event ID
Query parameters
limitinteger · max: 50OptionalDefault:
20offsetintegerOptionalDefault:
0Responses
200
Event users list.
application/json
statusintegerRequiredExample:
200get/events/{eventId}/users
200
Event users list.
Authorizations
x-api-keystringRequired
Path parameters
leadIdstringRequired
Lead ID
Body
firstNamestring · nullableOptional
lastNamestring · nullableOptional
emailstring · email · nullableOptional
addressstring · nullableOptional
linkedinstring · nullableOptional
facebookstring · nullableOptional
twitterstring · nullableOptional
profilePicturestring · nullableOptional
descriptionstring · nullableOptional
jobTitlestring · nullableOptional
Responses
200
Updated lead.
application/json
statusintegerRequiredExample:
200patch/leads/{leadId}
200
Updated lead.
Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault:
20offsetintegerOptionalDefault:
0leadIdstringOptional
Filter by associated lead ID
eventTypestring · enumOptionalPossible values:
Lead activity event type.
Responses
200
Lead activity events list.
application/json
statusintegerRequiredExample:
200get/leadActivityEvents
200
Lead activity events list.
Authorizations
x-api-keystringRequired
Query parameters
limitinteger · max: 50OptionalDefault:
20offsetintegerOptionalDefault:
0eventUrlstringOptional
Filter by exact event URL
qstringOptional
Full-text search query
Responses
200
Industry events list.
application/json
statusintegerRequiredExample:
200401
Unauthorized
application/json
get/industryEvents
Authorizations
x-api-keystringRequired
Body
namestringRequired
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
sourceTypestring · nullableOptional
sourceIdstring · nullableOptional
eventTypestring · nullableOptional
venueCitystring · nullableOptional
venueStatestring · nullableOptional
venueCountrystring · nullableOptional
venueNamestring · nullableOptional
venueFullAddressstring · nullableOptional
venueCoordinatesstring · nullableOptional
numberOfAttendeesinteger · nullableOptional
numberOfExhibitorsinteger · nullableOptional
attendeeCoststring · nullableOptional
boothCoststring · nullableOptional
exhibitorIndustriesstring[] · nullableOptional
attendeePersonasstring[] · nullableOptional
keywordsstring[] · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
eventUrlstring · nullableOptional
Responses
200
Created or existing industry event.
application/json
statusintegerRequiredExample:
200400
Bad request
application/json
post/industryEvents
Authorizations
x-api-keystringRequired
Path parameters
industryEventIdstring · uuidRequired
Industry event ID
Body
namestringOptional
startDatestring · date-time · nullableOptional
endDatestring · date-time · nullableOptional
sourceTypestring · nullableOptional
sourceIdstring · nullableOptional
eventTypestring · nullableOptional
venueCitystring · nullableOptional
venueStatestring · nullableOptional
venueCountrystring · nullableOptional
venueNamestring · nullableOptional
venueFullAddressstring · nullableOptional
venueCoordinatesstring · nullableOptional
numberOfAttendeesinteger · nullableOptional
numberOfExhibitorsinteger · nullableOptional
attendeeCoststring · nullableOptional
boothCoststring · nullableOptional
exhibitorIndustriesstring[] · nullableOptional
attendeePersonasstring[] · nullableOptional
keywordsstring[] · nullableOptional
websitestring · nullableOptional
descriptionstring · nullableOptional
eventUrlstring · nullableOptional
Responses
200
Updated industry event.
application/json
statusintegerRequiredExample:
200404
Not found
application/json
put/industryEvents/{industryEventId}
Last updated
Was this helpful?