Create a customer callout

Preferred callout creation endpoint. The customer must have an active subscription. Provide either live coordinates or a fixed location (predefinedLocationId) depending on the integration model.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerIdintegerRequired
Customer identifier.

Request

This endpoint expects an object.
locationobjectRequired
responseTypeIdintegerRequired
calloutClassificationIdintegerOptional
internalTestbooleanOptional

Legacy flag that routes the callout to a specific test supplier attached to your customer source. Not used by modern integrations — omit it and test with the staging Responder Simulator instead.

Response

Successful.
messagestring
calloutobject

Errors

400
Bad Request Error
401
Unauthorized Error