Skip to content
Highlight Docs

Initiate collection deployment

POST
/collection/{highlightId}/deploy

Start the deployment workflow for a draft collection.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
highlightId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Deployment initiated

object
status
required
string
Allowed values: Pending InProgress Completed Failed
currentStep
required
string
Allowed values: Validate UploadMetadata UploadCode GenerateTransaction AwaitTransaction RecordTransaction
steps
required
Array<object>
object
step
required
string
status
required
string
error
string
contractConfig
required
Any of:
object
chainId
required
number
to
required
Any of:
string
data
required
string
value
required
string
txHash
required
Any of:
string
error
required
Any of:
string
deploymentId
required
string
highlightId
required
string

400

Section titled “400 ”

Invalid request

401

Section titled “401 ”

Unauthorized

403

Section titled “403 ”

Forbidden

404

Section titled “404 ”

Not found