Voyages::Flex_fields
[DEPRECATED] This resource allows you modify flex fields for voyages in Octopi.

[DEPRECATED] Please use the Containers API to manage flex flex fields for voyages. This resource allows you to access flex fields for voyages in Octopi

Supported Formats

json
>>>

PUT /api/v1/voyages/:number/flex_fields/:label
Updates a Voyage

[DEPRECATED] Please use the Containers API to manage flex flex fields for voyages. This resource allows you to access flex fields for voyages in Octopi.

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/voyages/NUMBER/flex_fields/flex_field_label" \
     -X PUT \
     "Authorization: Token token=ADD TOKEN HERE" \
     -d '{ "value": "FLEX_FIELD_VALUE" }'

"value": "FLEX_FIELD_VALUE"

Params

Param name Description
number
required

Voyage number

Validations:

  • Must be a String
label
required

Label of the flex field

Validations:

  • Must be a String
value
required

Value of the flex field to change

Validations:

  • Must be a String