This API endpoint allows you to update a consignee.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Not Found.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/consignees/353388.json" -X PUT -d '{ "name" : "FC UNITED LLC", "customs_code": "222", "vat_number": "111"}' -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"
{
   "consignee" : {
      "customs_code" : "222",
      "contact_person" : "Joe Jones",
      "phone" : null,
      "general_ledger_id" : "SL1231",
      "vat_number" : "111",
      "name" : "FC UNITED LLC",
      "address" : "123 Main St",
      "email" : "joe@example.com",
      "billing_contact_email" : "accounting@example.com",
      "id" : 353388
   }
}

Params

Param name Description
id
required

Validations:

  • Must be String