Skip to main content

External Drivers - Upsert

Overview​

This endpoint allows you to update or create an external driver based on the attribute partners_external_identifier.

Request​

PUT /v1/accounts/{account_uuid}/external-drivers/upsert​

Example Request​

PUT v1/accounts/100000ben1es/external-drivers/upsert
  • Body:
{
  "first_name": "Jake",
  "last_name": "Smith",
  "invitation_email": "jake.smith@captain.ai",
  "invitation_phone_number": "+447455644550",
  "active": true,
  "partners_external_identifier": "POS2-4564"
}

Response #1​

  • Status: 200

  • Body:

{
  "account_uuid": "100000ben1es",
  "uuid": "62d4c15f21a",
  "partners_external_identifier": "POS2-4564",
  "first_name": "Jake",
  "last_name": "Smith",
  "email": "jake.smith@captain.ai",
  "phone_number": "+447455644550",
  "active": true
}

Response #2 (validation error)​

  • Status: 422

  • Body:

    {
      "errors": ["Account uuid can't be blank"]
    }