Update Source of Business

PATCH /v1/sources-of-business/{sourceOfBusinessId}

Update Source of Business

Path parameters

  • sourceOfBusinessId string(uuid) Required

    The id of the source of business.

application/json

Body

The properties of the source of business to update.

  • name string | null

    The name of the source of business.

Responses

  • 200 application/json

    Request succeeded.

    Hide response attributes Show response attributes object
    • id string(uuid)

      The unique id.

    • createdTimestamp string(date-time) | null

      The date and time of creation in UTC time.

    • modifiedTimestamp string(date-time) | null

      The date and time last modification in UTC time.

    • name string Required

      The name of the source of business.

    • code string Required

      The unique code for the source of business.

  • 400 application/json

    Invalid request. See response body for details.

    Hide response attributes Show response attributes object
    • id string

      The unique identifier for the error.

    • code integer(int32)

      A code used to help identify the type of error. This is typically set to the same value as the http status code.

    • message string

      A summary or short message describing the error.

    • details array[string] | null

      A list of more detailed errors messages.

  • 401 application/json

    Unauthorized. See response body for details.

    Hide response attributes Show response attributes object
    • id string

      The unique identifier for the error.

    • code integer(int32)

      A code used to help identify the type of error. This is typically set to the same value as the http status code.

    • message string

      A summary or short message describing the error.

    • details array[string] | null

      A list of more detailed errors messages.

  • 403 application/json

    Permission denied. See response body for details.

    Hide response attributes Show response attributes object
    • id string

      The unique identifier for the error.

    • code integer(int32)

      A code used to help identify the type of error. This is typically set to the same value as the http status code.

    • message string

      A summary or short message describing the error.

    • details array[string] | null

      A list of more detailed errors messages.

  • 404 application/json

    Not found. See response body for details.

    Hide response attributes Show response attributes object
    • id string

      The unique identifier for the error.

    • code integer(int32)

      A code used to help identify the type of error. This is typically set to the same value as the http status code.

    • message string

      A summary or short message describing the error.

    • details array[string] | null

      A list of more detailed errors messages.

  • 422 application/json

    Validation failed. See response body for details.

    Hide response attributes Show response attributes object
    • id string

      The unique identifier for the error.

    • code integer(int32)

      A code used to help identify the type of error. This is typically set to the same value as the http status code.

    • message string

      A summary or short message describing the error.

    • details array[string] | null

      A list of more detailed errors messages.

PATCH /v1/sources-of-business/{sourceOfBusinessId}
curl \
 --request PATCH 'https://api.lwolf.com/backoffice/v1/sources-of-business/{sourceOfBusinessId}' \
 --header "Content-Type: application/json" \
 --data '{"name":"string"}'
Request example
{
  "name": "string"
}
Response examples (200)
{
  "id": "string",
  "code": "string",
  "name": "string",
  "createdTimestamp": "string",
  "modifiedTimestamp": "string"
}
Response examples (400)
{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}
Response examples (401)
{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}
Response examples (403)
{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}
Response examples (404)
{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}
Response examples (422)
{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}