Skip to navigation
API Referencecollections

Patch Collection

Rename a collection and/or add, replace, or remove clauses by id.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

collection_idstringRequired

Headers

X-Channel3-LanguagestringOptional
X-Channel3-CountrystringOptional
X-Channel3-CurrencystringOptional
X-Channel3-Length-UnitstringOptional
X-Channel3-Weight-UnitstringOptional

Request

This endpoint expects an object.
namestring or nullOptional
descriptionstring or nullOptional<=1000 characters
add_clauseslist of objects or nullOptional
replace_clauseslist of objects or nullOptional

Replace existing clauses in place by clause_id. Position in the clauses list is unchanged.

remove_clause_idslist of strings or nullOptional

Response

Successful Response
collection_idstring
namestring
clauseslist of objects
created_atdatetime
updated_atdatetime
descriptionstring or nullOptional
user_idstring or nullOptional

Errors

401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error