ZOzocdoc
schedulable-entities

Submit NPI overlaps

Submit NPI overlaps to compare your provider directory with providers bookable on Zocdoc. Send real-time distribution status (developer_app_state), unverified addresses and other data required for joint provider operations.

put/v1/schedulable_entities/overlaps

Request

  • Base URL
    https://api-developer-sandbox.zocdoc.com
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.schedulable_entity.read
    • or OAuth 2
      Authorization code: https://auth.zocdoc.com/authorize
      Token URL: https://auth.zocdoc.com/oauth/token scopes: external.schedulable_entity.read

Request body

developer_app_state'disabled' | 'enabled' required

Indicates whether each provider in the request is currently active in your application and able to receive bookings. Send enabled when the provider is live and bookable in your app, or disabled when the provider is suppressed or not currently available for booking. This value applies to every item in overlaps. For an item with entity_id, it is stored for that provider location. Submit separate requests when providers or locations have different states.

Response

OK

request_idstring required

Unique request identifier for tracing

Changes

No recorded changes to this operation across all 1 revision of this API.