batches

Assign user to a batch

Changed on

Assign a user to a batch. Assigning a user replaces any existing assignment.

put/v1/batches/{batch_id}/user

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/batches/{batch_id}/user
  • Auth: API key in header API-Key

Request body

assigned_userstring uuid required

The ID of the user to assign to the batch. The user must be an active member of your account.

Example request

{
  "assigned_user": "a2df9fa5-b7ee-467f-be4e-9c660542c187"
}

Response

The request was successful.

string required

Changes

    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ▲

      the / response's property type changed from no type to object for status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      removed from the / response property allOf list for the response status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      endpoint added