BObookingexperts
Conversations

POST conversation

Changed on

Create a new conversation

post/v3/administrations/{administration_id}/conversations

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

fields[conversation]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Request body

Example request

{
  "data": {
    "type": "conversation",
    "relationships": {
      "booking": {
        "data": {
          "type": "booking"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "booking",
      "attributes": {
        "customer_desires_downpayment": true,
        "booker_desires_downpayment": true,
        "option_validity": 3,
        "locale": "cs",
        "currency": "EUR"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer"
          }
        },
        "owner": {
          "data": {
            "type": "owner"
          }
        },
        "traffic_source": {
          "data": {
            "type": "traffic_source"
          }
        },
        "conversation": {
          "data": {
            "type": "conversation"
          }
        },
        "credit_cards": {
          "data": [
            {
              "type": "credit_card"
            }
          ]
        },
        "security_deposits": {
          "data": [
            {
              "type": "security_deposit"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "channel": {
          "data": {
            "type": "channel"
          }
        },
        "guest_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "customer_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "channel_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "reservations": {
          "data": [
            {
              "type": "reservation"
            }
          ]
        },
        "payments": {
          "data": [
            {
              "type": "payment"
            }
          ]
        }
      }
    }
  ]
}

Response

ConversationResponse

Example response

{
  "data": {
    "id": "1",
    "type": "conversation",
    "relationships": {
      "booking": {
        "data": {
          "type": "booking"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "booking",
      "attributes": {
        "customer_desires_downpayment": true,
        "booker_desires_downpayment": true,
        "option_validity": 3,
        "locale": "cs",
        "currency": "EUR"
      },
      "relationships": {
        "customer": {
          "data": {
            "type": "customer"
          }
        },
        "owner": {
          "data": {
            "type": "owner"
          }
        },
        "traffic_source": {
          "data": {
            "type": "traffic_source"
          }
        },
        "conversation": {
          "data": {
            "type": "conversation"
          }
        },
        "credit_cards": {
          "data": [
            {
              "type": "credit_card"
            }
          ]
        },
        "security_deposits": {
          "data": [
            {
              "type": "security_deposit"
            }
          ]
        },
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "channel": {
          "data": {
            "type": "channel"
          }
        },
        "guest_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "customer_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "channel_invoice": {
          "data": {
            "type": "invoice"
          }
        },
        "reservations": {
          "data": [
            {
              "type": "reservation"
            }
          ]
        },
        "payments": {
          "data": [
            {
              "type": "payment"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • warning

      added the new da-DK enum value to the /////// response property for the response status

    • warning

      added the new en-GB enum value to the /////// response property for the response status

    • warning

      added the new en-US enum value to the /////// response property for the response status

    • info

      added the new da-DK enum value to the request property ///////

    • info

      added the new en-GB enum value to the request property ///////

    • info

      added the new en-US enum value to the request property ///////

    • info

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