destinations

Creates new destination

post/destinations/{destinationName}

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/destinations/{destinationName}
  • Auth: none declared

Path parameters

destinationNamestring required

Request body

labelstring

Response

Creates new destination

customer_idstring

The id of the customer (account) the document belongs to.

labelstring

Your own textual label for the document. By using labels you can easily identify your documents later.

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

o_auth_idstring
authorizer_idstring
idstring nullable
descriptionstring
statusboolean
status_detailstring
last_usestring date-time nullable
created_atinteger
updated_atinteger

Example response

{
  "authorizer_id": "P6T8tazCWdf3pkVzIAlnZa10gh"
}

Changes

No recorded changes to this operation across all 1 revision of this API.