Versify

&lt;h1>API Reference&lt;/h1>&lt;p>The Versify API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;p>&nbsp;&lt;/p>

Versify is a suite of easy-to-use tools powering NFT solutions for businesses of all sizes. Create digital collectibles and distribute them to your customers at scale.

Versify | API Reference

API Reference

&lt;h1>Authentication&lt;/h1>&lt;p>The Versify API uses API keys to authenticate requests. You can view and manage your API key in the Versify dashboard.&lt;/p>

Authentication

&lt;h1>Errors&lt;/h1>&lt;p>Versify uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error with Versify's servers.&lt;/p>

Errors

&lt;h1>Airdrops&lt;/h1>&lt;p>Airdrops are a bulk distribution of collectibles to an audience. For example, you might create an airdrop to send a new collectible to all of your customers who belong to the same email domain.&lt;/p>

&lt;h1>The airdrop object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘collection’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>archived&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the airdrop is archived. If false, airdrop is not displayed in dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;tr>&lt;td>email_settings&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>object&lt;/td>&lt;td>Settings object determining the structure of the email that is sent to the recipients of the airdrop.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>mint_link&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>ID of the mint link that is sent alongside the airdrop.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The airdrop's name. Used to help identify the airdrop in the dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>ID of the product that is sent in this airdrop.&lt;/td>&lt;/tr>&lt;tr>&lt;td>recipients&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>object&lt;/td>&lt;td>The list of recipients that are being sent the airdrop.&lt;/td>&lt;/tr>&lt;tr>&lt;td>status&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The status of the airdrop. Starts as pending, then updates to complete once all the emails have been sent.&lt;/td>&lt;/tr>&lt;tr>&lt;td>updated&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time at which the object was last updated. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘collection’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>archived&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the airdrop is archived. If false, airdrop is not displayed in dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>email_settings&lt;/b> &lt;span style="font-size: .7em;">object&lt;/span> &lt;br/>&lt;span>Settings object determining the structure of the email that is sent to the recipients of the airdrop.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>mint_link&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>ID of the mint link that is sent alongside the airdrop.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The airdrop's name. Used to help identify the airdrop in the dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>ID of the product that is sent in this airdrop.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>recipients&lt;/b> &lt;span style="font-size: .7em;">object&lt;/span> &lt;br/>&lt;span>The list of recipients that are being sent the airdrop.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>status&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The status of the airdrop. Starts as pending, then updates to complete once all the emails have been sent.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>updated&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time at which the object was last updated. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Airdrop Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
    &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"air_632ca20c824567f5ea38a23c"&lt;/span>,
    &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"airdrop"&lt;/span>,
    &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1663869452&lt;/span>,
    &lt;span class="hljs">"metadata"&lt;/span>: {},
    &lt;span class="hljs">"updated"&lt;/span>: &lt;span class="hljs">1664554811&lt;/span>,
    &lt;span class="hljs">"account"&lt;/span>: &lt;span class="hljs">"acct_6320f8f70aaa3edca008f913"&lt;/span>,
    &lt;span class="hljs">"archived"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
    &lt;span class="hljs">"email_settings"&lt;/span>: {
        &lt;span class="hljs">"content"&lt;/span>: &lt;span class="hljs">"Claim your free NFT."&lt;/span>,
        &lt;span class="hljs">"from_email"&lt;/span>: &lt;span class="hljs">"airdrops@versifylabs.com"&lt;/span>,
        &lt;span class="hljs">"from_image"&lt;/span>: &lt;span class="hljs">"https://s3.amazonaws.com/cdn-dev.versifylabs.com/tmp/f18775d1-af98-4764-953a-8e4bfd00807b"&lt;/span>,
        &lt;span class="hljs">"from_name"&lt;/span>: &lt;span class="hljs">"Versify Labs"&lt;/span>,
        &lt;span class="hljs">"preview_text"&lt;/span>: &lt;span class="hljs">"Claim your free NFT from Versify Labs"&lt;/span>,
        &lt;span class="hljs">"subject_line"&lt;/span>: &lt;span class="hljs">"Claim your free NFT from Versify Labs"&lt;/span>
    },
    &lt;span class="hljs">"mint_link"&lt;/span>: &lt;span class="hljs">"mlink_632ca216199aa3a35d21ab32"&lt;/span>,
    &lt;span class="hljs">"name"&lt;/span>: &lt;span class="hljs">"Sep 22 Airdrop"&lt;/span>,
    &lt;span class="hljs">"product"&lt;/span>: &lt;span class="hljs">"prod_632122daafb2615251ac5685"&lt;/span>,
    &lt;span class="hljs">"recipients"&lt;/span>: {
        &lt;span class="hljs">"count"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
        &lt;span class="hljs">"segment_options"&lt;/span>: {
            &lt;span class="hljs">"conditions"&lt;/span>: &lt;span class="hljs">"tags:\"Team\""&lt;/span>,
            &lt;span class="hljs">"match"&lt;/span>: &lt;span class="hljs">"all"&lt;/span>
        },
        &lt;span class="hljs">"emails_included"&lt;/span>: [],
        &lt;span class="hljs">"emails_excluded"&lt;/span>: [],
        &lt;span class="hljs">"tags_included"&lt;/span>: [],
        &lt;span class="hljs">"tags_excluded"&lt;/span>: []
    },
    &lt;span class="hljs">"status"&lt;/span>: &lt;span class="hljs">"complete"&lt;/span>
}&lt;/code>&lt;/pre>

The airdrop object

Content-Type

{
    "email_settings": {
        "content": "Test Airdrop",
        "from_name": "ACME Corp",
        "from_name": "ACME",
        "from_image": null,
        "preview_text": "Airdrop from ACME Corp",
        "subject_line": "Airdrop from ACME Corp"
    },
    "name": "First Airdrop",
    "product": "prod_123",
    "recipients": {
        "segment_options": {
            "match": "all",
            "conditions": ""
        }
    },
}

&lt;h1>Create an airdrop&lt;/h1>&lt;p>Creates a new airdrop object.&lt;/p>&lt;h3>&nbsp;&lt;/h3>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The airdrop's name.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The airdrop's name.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns the airdrop object if the call succeeded.&lt;/p>

Create an airdrop

Takes the airdrop draft and sends it to the recipients specified. The airdrop details cannot be modified after the airdrop is sent.

Authorization

Versify-Account

&lt;h1>Send an airdrop&lt;/h1>&lt;p>Takes the airdrop draft and sends it to the recipients specified. The airdrop details cannot be modified after the airdrop is sent.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updated airdrop object if successful. Otherwise, this call raises an error.&lt;/p>

Send an airdrop

expand

&lt;h1>Retrieve an airdrop&lt;/h1>&lt;p>Retrieves the details of an existing airdrop. Supply the unique airdrop ID from either a airdrop creation request or the airdrop list, and Versify will return the corresponding airdrop information.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns an airdrop object if a valid airdrop ID was provided. Raises an error otherwise.&lt;/p>

Retrieve an airdrop

&lt;h1>Update an airdrop&lt;/h1>&lt;p>Updates the specific airdrop by setting the values of the parameters of the parameters passed. Any parameters not provided will be left unchanged.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>archived&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the airdrop is archived. If true, airdrops will not be shown in the dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The airdrop name.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>archived&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the airdrop is archived. If true, airdrops will not be shown in the dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The airdrop name.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updated airdrop object if successful. Otherwise, this call raises an error.&lt;/p>

Update an airdrop

page_num

page_size

status

&lt;h1>List all airdrops&lt;/h1>&lt;p>Returns a list of your airdrops. The airdrops are returned sorted by creation date, with the most recently created appearing first.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a &lt;code>data&lt;/code> property that contains an array of up to &lt;code>page_size&lt;/code> collections. Each entry in the array is a separate collection object. If no more collections are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all airdrops

Airdrops

&lt;h1>Collections&lt;/h1>&lt;p>Collections describe a specific group of products that can be minted as NFTs. For example, you might create a ‘Looney Tunes' collection that contains several products in It, including a ‘Bugs Bunny’ product. Collections have a one-to-one relationship with ERC1155 smart contracts.&nbsp;&lt;/p>

&lt;h1>The collection object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘collection’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the collection is active. If false, products cannot be created for it.&lt;/td>&lt;/tr>&lt;tr>&lt;td>contract_address&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The address for the smart contract that was deployed to the blockchain.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time. at which the object was created. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>signature&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The signature hash of the blockchain transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>status&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The status of the collection. Starts as pending, then updates to deployed once the contract is deployed.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of strings used to organize the collections with the Versify platform.&lt;/td>&lt;/tr>&lt;tr>&lt;td>transaction&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The hash of the blockchain transaction.&lt;/td>&lt;/tr>&lt;tr>&lt;td>uri&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The smart contracts token metadata location.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘collection’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the collection is active. If false, products cannot be created for it.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>contract_address&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The address for the smart contract that was deployed to the blockchain.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time. at which the object was created. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>signature&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The signature hash of the blockchain transaction.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>status&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The status of the collection. Starts as pending, then updates to deployed once the contract is deployed.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of strings used to organize the collections with the Versify platform.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>transaction&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The hash of the blockchain transaction.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>uri&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The smart contracts token metadata location.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Collection Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
     &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"coll_123"&lt;/span>,
     &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"collection"&lt;/span>,
     &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1656595212&lt;/span>,
     &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
     &lt;span class="hljs">"contract_address"&lt;/span>: &lt;span class="hljs">"0x57de9894042296e48a90da9ec8e05e806aa12460"&lt;/span>,
     &lt;span class="hljs">"description"&lt;/span>: &lt;span class="hljs">"Group of tokens from the Looney Tunes squad."&lt;/span>,
     &lt;span class="hljs">"image"&lt;/span>: &lt;span class="hljs">"https://cdn.versifylabs.com/123"&lt;/span>,
     &lt;span class="hljs">"metadata"&lt;/span>: {},
     &lt;span class="hljs">"name"&lt;/span>: &lt;span class="hljs">"The Looney Tunes"&lt;/span>,
     &lt;span class="hljs">"signature"&lt;/span>: &lt;span class="hljs">"123456789"&lt;/span>,
     &lt;span class="hljs">"status"&lt;/span>: &lt;span class="hljs">"complete"&lt;/span>,
     &lt;span class="hljs">"tags"&lt;/span>: [],
     &lt;span class="hljs">"transaction"&lt;/span>: &lt;span class="hljs">"0xd462d94c0f74ff057e485b85048a5cc557df58a4348bebb190b783a9239516da"&lt;/span>,
     &lt;span class="hljs">"uri"&lt;/span>: &lt;span class="hljs">"https://cdn.versifylabs.com/coll_123/{id}.json"&lt;/span>
}&lt;/code>&lt;/pre>

The collection object

Just a random test collection with no value

Test Collection

&lt;h1>Create a collection&lt;/h1>&lt;p>Creates a new collection object.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the collection is active. If false, products cannot be created for it.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the collection is active. If false, products cannot be created for it.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The collection's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns the collection object if the call succeeded.&lt;/p>

Create a collection

&lt;h1>Retrieve a collection&lt;/h1>&lt;p>Retrieves the details of an existing collection. Supply the unique collection ID from either a collection creation request or the collection list, and Versify will return the corresponding collection information.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a collection object if a valid collection ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a collection

&lt;h1>Update a collection&lt;/h1>&lt;p>Updates the specific collection. by setting the values of the parameters of the parameters passed. Any parameters not provided will be left unchanged.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the collection is active. If false, products cannot be created for it.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the collection is active. If false, products cannot be created for it.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updated collection object if successful. Otherwise, this call raises an error.&lt;/p>

Update a collection

active

&lt;h1>List all collections&lt;/h1>&lt;p>Returns a list of your collections. The collections are returned sorted by creation date, with the most recently created products appearing first.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a &lt;code>data&lt;/code> property that contains an array of up to &lt;code>page_size&lt;/code> collections. Each entry in the array is a separate collection object. If no more collections are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all collections

Collections

&lt;h1>Contacts&lt;/h1>&lt;p>This object represents a contact of your organization. It lets you send them NFTs and track transactions that belong to the same person.&lt;/p>

&lt;h1>The contact object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘contact’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/td>&lt;/tr>&lt;tr>&lt;td>address&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>avatar&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The image used to identify the contact. Used for the dashboard only.&lt;/td>&lt;/tr>&lt;tr>&lt;td>balance&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time. at which the object was created. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;tr>&lt;td>currency&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's description, not meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>email&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's email address..&lt;/td>&lt;/tr>&lt;tr>&lt;td>first_name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's first name&lt;/td>&lt;/tr>&lt;tr>&lt;td>last_name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's last name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's full name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phone&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's phone number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>shipping&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>source&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of tags used to organize and segment contact's.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘contact’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>address&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>avatar&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The image used to identify the contact. Used for the dashboard only.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>balance&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time. at which the object was created. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>currency&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's description, not meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>email&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's email address..&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>first_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's first name&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>last_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's last name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's full name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>phone&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's phone number.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>shipping&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>source&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of tags used to organize and segment contact's.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>The Contact Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
    &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"cont_123"&lt;/span>,
    &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"contact"&lt;/span>,
    &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1656548724&lt;/span>,
    &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
    &lt;span class="hljs">"address"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"avatar"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"balance"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
    &lt;span class="hljs">"currency"&lt;/span>: &lt;span class="hljs">"usd"&lt;/span>,
    &lt;span class="hljs">"description"&lt;/span>: &lt;span class="hljs">""&lt;/span>,
    &lt;span class="hljs">"email"&lt;/span>: &lt;span class="hljs">"jane@example.com"&lt;/span>,
    &lt;span class="hljs">"first_name"&lt;/span>: &lt;span class="hljs">"Jane"&lt;/span>,
    &lt;span class="hljs">"last_name"&lt;/span>: &lt;span class="hljs">"Doe"&lt;/span>,
    &lt;span class="hljs">"metadata"&lt;/span>: {},
    &lt;span class="hljs">"name"&lt;/span>: &lt;span class="hljs">""&lt;/span>,
    &lt;span class="hljs">"phone"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"shipping"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"source"&lt;/span>: &lt;span class="hljs">"Versify"&lt;/span>,
    &lt;span class="hljs">"tags"&lt;/span>: []
}
&lt;/code>&lt;/pre>

The contact object

{
  "email": "jane@example.com",
  "first_name": "Jane",
  "last_name": "Doe"
}

&lt;h1>Create a contact&lt;/h1>&lt;p>A contact must have an email. You can also create contacts in the contacts tab of the dashboard.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/td>&lt;/tr>&lt;tr>&lt;td>avatar&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The image used to identify the contact. Used for the dashboard only.&lt;/td>&lt;/tr>&lt;tr>&lt;td>currency&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's description, not meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>email&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's email address..&lt;/td>&lt;/tr>&lt;tr>&lt;td>first_name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's first name&lt;/td>&lt;/tr>&lt;tr>&lt;td>last_name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's last name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's full name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phone&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's phone number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>source&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of tags used to organize and segment contact's.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>avatar&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The image used to identify the contact. Used for the dashboard only.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>currency&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's description, not meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>email&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The contact's email address..&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>first_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's first name&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>last_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's last name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's full name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>phone&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's phone number.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>source&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of tags used to organize and segment contact's.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>Returns&lt;/h3>&lt;p>Returns the contact object if the creation succeeded. Raises an error if create parameters are invalid.&lt;/p>

Create a contact

&lt;h1>Retrieve a contact&lt;/h1>&lt;p>Retrieves a Contact object with the given ID.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a Contact object if a valid contact ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a contact

&lt;h1>Update a contact&lt;/h1>&lt;p>Updates the specific contact. by setting the values of the parameters of the parameters passed. Any parameters not provided will be left unchanged.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/td>&lt;/tr>&lt;tr>&lt;td>avatar&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The image used to identify the contact. Used for the dashboard only.&lt;/td>&lt;/tr>&lt;tr>&lt;td>currency&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Not currently used.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's description, not meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>first_name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's first name&lt;/td>&lt;/tr>&lt;tr>&lt;td>last_name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's last name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's full name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>phone&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The contact's phone number.&lt;/td>&lt;/tr>&lt;tr>&lt;td>source&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of tags used to organize and segment contact's.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the contact is active. If false, contacts are considered ‘archived’ and cannot be sent NFTs.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>avatar&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The image used to identify the contact. Used for the dashboard only.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>currency&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Not currently used.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's description, not meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>first_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's first name&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>last_name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's last name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's full name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>phone&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The contact's phone number.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>source&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The source where the contact was added from. Will be ‘Versify’ if It was created in the dashboard.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of tags used to organize and segment contact's.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updates contact object if successful. Otherwise, this call raises an error.&lt;/p>

Update a contact

List all contacts

Contacts

&lt;h1>Events&lt;/h1>&lt;p>Events are our way of letting you know when something interesting happens in your account. When an interesting event occurs, we create a new &lt;code>Event&lt;/code> object. For example, when an NFT is minted, we create a &lt;code>mint.created&lt;/code> event. Note that many API requests may cause multiple events to be created. For example, if you create an airdrop with multiple recipients, you will receive an airdrop.created event and a &lt;code>mint.created&lt;/code> event for each recipient.&lt;/p>&lt;p>Events occur when the state of another API resource changes. The state of that resource at the time of the change is embedded in the event's data field. For example, a &lt;code>contact.created&lt;/code> event will contain a contact, and a &lt;code>product.created&lt;/code> event will contain a product. As with other API resources, you can use endpoints to retrieve an individual event or a list of events from the API. We also have a separate webhooks system for sending the &lt;code>Event&lt;/code> objects directly to an endpoint on your server. Webhooks are managed in your account settings.&lt;/p>

&lt;h1>The event object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘mint_link’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The public URL that can be shared with contacts.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">&nbsp;&lt;/span> &lt;br/>&lt;span>&nbsp;&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘mint_link’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The public URL that can be shared with contacts.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Contact Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
  &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"evt_123"&lt;/span>,
  &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"event"&lt;/span>,
  &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1655927455&lt;/span>,
  &lt;span class="hljs">"data"&lt;/span>: {
    &lt;span class="hljs">"object"&lt;/span>: {
      &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"cont_123"&lt;/span>,
      &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"contact"&lt;/span>,
      &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
      &lt;span class="hljs">"balance"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
      &lt;span class="hljs">"currency"&lt;/span>: &lt;span class="hljs">"usd"&lt;/span>
    }
  },
  &lt;span class="hljs">"pending_webhooks"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
  &lt;span class="hljs">"request"&lt;/span>: {},
  &lt;span class="hljs">"type"&lt;/span>: &lt;span class="hljs">"contact.created"&lt;/span>
}
&lt;/code>&lt;/pre>

The event object

&lt;h1>Retrieve an event&lt;/h1>&lt;p>Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns an event object if a valid identifier was provided. All events share a common structure, detailed to the right. The only property that will differ is the data property.&nbsp;&lt;/p>&lt;p>In each case, the data dictionary will have an attribute called object and its value will be the same as retrieving the same object directly from the API. For example, a contact.created event will have the same information as retrieving the relevant contact would.&nbsp;&lt;/p>&lt;p>In cases where the attributes of an object have changed, data will also contain a dictionary containing the changes.&lt;/p>

Retrieve an event

type

&lt;h1>List all events&lt;/h1>&lt;p>List events.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>type&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A string containing a specific event name.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>type&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A string containing a specific event name.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a data property that contains an array of up to page_size events. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all events

Events

&lt;h1>Mint Links&lt;/h1>&lt;p>A mint link is a shareable URL that will take your contacts to a hosted mint page. A mint link can be shared and used multiple times.&nbsp;&lt;/p>

&lt;h1>The mint link object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘mint_link’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The public URL that can be shared with contacts.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘mint_link’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The public URL that can be shared with contacts.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Mint Link Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
    &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"mlink_123"&lt;/span>,
    &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"mint_link"&lt;/span>,
    &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1657058294&lt;/span>,
    &lt;span class="hljs">"metadata"&lt;/span>: {},
    &lt;span class="hljs">"product"&lt;/span>: &lt;span class="hljs">"prod_123"&lt;/span>,
    &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
    &lt;span class="hljs">"url"&lt;/span>: &lt;span class="hljs">"https://mint.versifylabs.com/link/mlink_123"&lt;/span>
}&lt;/code>&lt;/pre>

The mint link object

{
  "product": "prod_62bd0610efb7815fc2fcf9ac"
}

&lt;h1>Create a mint link&lt;/h1>&lt;p>Creates a mint link for a specific product.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns the mint link object.&lt;/p>

Create a mint link

&lt;h1>Retrieve a mint link&lt;/h1>&lt;p>Retrieves the mint link with the given ID.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a mint link if a valid ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a mint link

&lt;h1>Update a mint link&lt;/h1>&lt;p>Updates the mint link. You may update whether or not your webhook is &lt;code>active&lt;/code>.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updated mint links object if successful. Otherwise, this call raises an error.&lt;/p>

Update a mint link

&lt;h1>List all mint links&lt;/h1>&lt;p>Returns a list of your mint links.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Only return mint links that are active or inactive.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Only return mint links that are active or inactive.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a &lt;code>data&lt;/code> property that contains an array of up to &lt;code>page_size&lt;/code> mint links. Each entry in the array is a separate mint link object. If no more mint links are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all mint links

Mint Links

&lt;h1>Mints&lt;/h1>&lt;p>To mint an NFT, you create a Mint object for a contact and product.&lt;/p>

&lt;h1>The mint object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘mint_link’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>airdrop&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the airdrop associated with this mint, if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>contact&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>ID of the customer this mint. is for if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>mint_link&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the mint link associated with this mint, if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>status&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>enum&lt;/td>&lt;td>The status of the mint is either reserved, fulfilled, complete, or failed.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The public URL that was used for this mint.&lt;/td>&lt;/tr>&lt;tr>&lt;td>wallet_address&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The blockchain address of the recipient of this mint.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘mint_link’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>airdrop&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The ID of the airdrop associated with this mint, if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>contact&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>ID of the customer this mint. is for if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>&nbsp;&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>mint_link&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The ID of the mint link associated with this mint, if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>status&lt;/b> &lt;span style="font-size: .7em;">enum&lt;/span> &lt;br/>&lt;span>The status of the mint is either reserved, fulfilled, complete, or failed.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The public URL that was used for this mint.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>wallet_address&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The blockchain address of the recipient of this mint.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Mint Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
  &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"evt_123"&lt;/span>,
  &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"event"&lt;/span>,
  &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1655927455&lt;/span>,
  &lt;span class="hljs">"data"&lt;/span>: {
    &lt;span class="hljs">"object"&lt;/span>: {
      &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"cont_123"&lt;/span>,
      &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"contact"&lt;/span>,
      &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
      &lt;span class="hljs">"balance"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
      &lt;span class="hljs">"currency"&lt;/span>: &lt;span class="hljs">"usd"&lt;/span>
    }
  },
  &lt;span class="hljs">"pending_webhooks"&lt;/span>: &lt;span class="hljs">0&lt;/span>,
  &lt;span class="hljs">"request"&lt;/span>: {},
  &lt;span class="hljs">"type"&lt;/span>: &lt;span class="hljs">"contact.created"&lt;/span>
}&lt;/code>&lt;/pre>

The mint object

{
  "contact": "cont_123",
  "product": "prod_123"
}

&lt;h1>Create a mint&lt;/h1>&lt;p>A mint an NFT, you create a Mint object.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>airdrop&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the airdrop associated with this mint, if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>contact&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>ID of the customer this mint. is for if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>mint_link&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the mint link associated with this mint, if one exists.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>airdrop&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The ID of the airdrop associated with this mint, if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>contact&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>ID of the customer this mint. is for if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>mint_link&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The ID of the mint link associated with this mint, if one exists.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns the mint object.&lt;/p>

Create a mint

&lt;h1>Retrieve a mint&lt;/h1>&lt;p>Retrieves the details of a mint that has previously been created. Supply the unique mint ID that was returned from your previous request or associated with an airdrop or mint link.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a mint if a valid mint ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a mint

airdrop

&lt;h1>List all mints&lt;/h1>&lt;p>Returns a list of mints you've previously created. The mints are returned in sorted order, with the most recent mints appearing first.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>airdrop&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Only return mints for the airdrop specified by this airdrop ID.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>contact&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Only return mints for the contact specified by this contact ID.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>mint_link&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Only return mints for the mint link specified by this mint link ID.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Only return mints for the product specified by this product ID.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>airdrop&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Only return mints for the airdrop specified by this airdrop ID.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>contact&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Only return mints for the contact specified by this contact ID.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>mint_link&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Only return mints for the mint link specified by this mint link ID.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Only return mints for the product specified by this product ID.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a &lt;code>data&lt;/code> property that contains an array of up to &lt;code>page_size&lt;/code> objects. Each entry in the array is a separate object. If no more objects are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all mints

Mints

&lt;h1>Products&lt;/h1>&lt;p>Products describe the specific good that your customers can mint. For example, you might offer a ‘Bugs Bunny’ t-shirt product that can be minted on to the blockchain and used in the metaverse.&lt;/p>

&lt;h1>The product object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>Unique identifier for the object.&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘product’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the product is active. If false, the product cannot be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>chain&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>enum&lt;/td>&lt;td>The blockchain network that this product can be minted on. Right now, only ‘polygon’ is supported.&lt;/td>&lt;/tr>&lt;tr>&lt;td>collection&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the collection that this product belongs to.&lt;/td>&lt;/tr>&lt;tr>&lt;td>contract_address&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The address for the smart contract that was deployed to the blockchain.&lt;/td>&lt;/tr>&lt;tr>&lt;td>created&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>integer&lt;/td>&lt;td>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The product's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>properties&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of strings used to organize the product within the Versify platform.&lt;/td>&lt;/tr>&lt;tr>&lt;td>token_id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The token_id of the token that will be minted onto the blockchain.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Unique identifier for the object.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘product’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the product is active. If false, the product cannot be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>chain&lt;/b> &lt;span style="font-size: .7em;">enum&lt;/span> &lt;br/>&lt;span>The blockchain network that this product can be minted on. Right now, only ‘polygon’ is supported.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>collection&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The ID of the collection that this product belongs to.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>contract_address&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The address for the smart contract that was deployed to the blockchain.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>created&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>Time at which the object was created. Measured in seconds since the Unix epoch.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>properties&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of strings used to organize the product within the Versify platform.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>token_id&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The token_id of the token that will be minted onto the blockchain.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Product Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
    &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"prod_123"&lt;/span>,
    &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"product"&lt;/span>,
    &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1656555024&lt;/span>,
    &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
    &lt;span class="hljs">"chain"&lt;/span>: &lt;span class="hljs">"polygon"&lt;/span>,
    &lt;span class="hljs">"collection"&lt;/span>: &lt;span class="hljs">"coll_123"&lt;/span>,
    &lt;span class="hljs">"contract_address"&lt;/span>: &lt;span class="hljs">"0x123"&lt;/span>,
    &lt;span class="hljs">"creator_avatar"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"creator_name"&lt;/span>: &lt;span class="hljs">null&lt;/span>,
    &lt;span class="hljs">"description"&lt;/span>: &lt;span class="hljs">"Member of the Looney Tunes"&lt;/span>,
    &lt;span class="hljs">"image"&lt;/span>: &lt;span class="hljs">"https://cdn.versifylabs.com/123"&lt;/span>,
    &lt;span class="hljs">"metadata"&lt;/span>: {},
    &lt;span class="hljs">"name"&lt;/span>: &lt;span class="hljs">"Bugs Bunny"&lt;/span>,
    &lt;span class="hljs">"properties"&lt;/span>: [
        {
            &lt;span class="hljs">"name"&lt;/span>: &lt;span class="hljs">"Squad"&lt;/span>,
            &lt;span class="hljs">"value"&lt;/span>: &lt;span class="hljs">"Looney Tunes"&lt;/span>
        }
    ],
    &lt;span class="hljs">"tags"&lt;/span>: [],
    &lt;span class="hljs">"token_id"&lt;/span>: &lt;span class="hljs">"1"&lt;/span>
}
&lt;/code>&lt;/pre>

The product object

Test Product

Bugs Bunny

&lt;h1>Create a product&lt;/h1>&lt;p>Creates a new product object.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the product is active. If false, the product cannot be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>collection&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The ID of the collection that this product belongs to.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The product's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>properties&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of strings used to organize the product within the Versify platform.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the product is active. If false, the product cannot be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>collection&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The ID of the collection that this product belongs to.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The product's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>properties&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of strings used to organize the product within the Versify platform.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a product object if the call succeeded.&lt;/p>

Create a product

collection

&lt;h1>List all products&lt;/h1>&lt;p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;td>Min Length&lt;/td>&lt;td>Max Length&lt;/td>&lt;/tr>&lt;tr>&lt;td>collection&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>Only return products for the collection specified by this ID.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="fd3e8fd7-70da-4d60-aabc-361421753f75-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>collection&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>Only return products for the collection specified by this ID.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of objects to be returned. Range from 1 and 100, and defaults to 10.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a &lt;code>data&lt;/code> property that contains an array of up to &lt;code>page_size&lt;/code> objects. Each entry in the array is a separate object. If no more objects are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all products

&lt;h1>Retrieve a product&lt;/h1>&lt;p>Retrieves the details of an existing product with the given ID.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a product object if a valid ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a product

&lt;h1>Update a product&lt;/h1>&lt;p>Updates the specific product by setting the values of the values of the parameters passed.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the product is active. If false, the product cannot be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The product's description, meant to be displayable to the public.&lt;/td>&lt;/tr>&lt;tr>&lt;td>image&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A URL of the image for this collection.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>hash&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>name&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The collection's name.&lt;/td>&lt;/tr>&lt;tr>&lt;td>properties&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>tags&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A list of strings used to organize the product within the Versify platform.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the product is active. If false, the product cannot be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product's description, meant to be displayable to the public.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>image&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A URL of the image for this collection.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>name&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The collection's name.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>properties&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>tags&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A list of strings used to organize the product within the Versify platform.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updated product object if successful. Otherwise, this call raises an error.&lt;/p>

Update a product

Products

&lt;h1>Search&lt;/h1>&lt;p>Search for data you've previously created using Versify's query language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages.&nbsp;&lt;/p>

Search data based on the search parameters specified

search_type

query

&lt;h1>Search data&lt;/h1>&lt;p>Returns a list of your data matching the search parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination.&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/td>&lt;/tr>&lt;tr>&lt;td>search_type&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>Enum representing the search type. Can be either ‘search_airdrops’, ‘search_contacts’, ‘search_products’&lt;/td>&lt;/tr>&lt;tr>&lt;td>query&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A string that must be included in the search type.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>search_type&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>Enum representing the search type. Can be either ‘search_airdrops’, ‘search_contacts’, ‘search_products’&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>query&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A string that must be included in the search type.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a data property that contains an array of up to page_size webhooks. Each entry in the array is a separate webhook object. If no more webhooks are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

Search contacts

Search

&lt;h1>Webhooks&lt;/h1>&lt;p>You can configure webhooks via the API to be notified about events that happen in your Versify account.&lt;/p>

&lt;h1>The webhook object&lt;/h1>&lt;p>&nbsp;&lt;/p>&lt;h3>Attributes&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>id&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;/tr>&lt;tr>&lt;td>object&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string, value is ‘mint_link’&lt;/td>&lt;td>String representing. the object's type. Objects of the same type share the same value.&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>boolean&lt;/td>&lt;td>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/td>&lt;/tr>&lt;tr>&lt;td>product&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The product that will be minted.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>hash&lt;/td>&lt;td>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>&nbsp;&lt;/td>&lt;td>string&lt;/td>&lt;td>The public URL that can be shared with contacts.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="91510d79-2eb8-44e9-be58-080b6521c3e8-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>id&lt;/b> &lt;span style="font-size: .7em;">&nbsp;&lt;/span> &lt;br/>&lt;span>&nbsp;&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>object&lt;/b> &lt;span style="font-size: .7em;">string, value is ‘mint_link’&lt;/span> &lt;br/>&lt;span>String representing. the object's type. Objects of the same type share the same value.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>Whether the mint link's url is active. If false, contacts visiting the URL will be shown a page saying that the link has been deactivated.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>product&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The product that will be minted.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">hash&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that can be used for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The public URL that can be shared with contacts.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;h3>&nbsp;&lt;/h3>&lt;h3>The Contact Object&lt;/h3>&lt;pre>&lt;code class="language-json">{
  &lt;span class="hljs">"id"&lt;/span>: &lt;span class="hljs">"wh_dgj2392rFSDF23dsFs3"&lt;/span>,
  &lt;span class="hljs">"object"&lt;/span>: &lt;span class="hljs">"webhook"&lt;/span>,
  &lt;span class="hljs">"active"&lt;/span>: &lt;span class="hljs">true&lt;/span>,
  &lt;span class="hljs">"created"&lt;/span>: &lt;span class="hljs">1777888999&lt;/span>,
  &lt;span class="hljs">"description"&lt;/span>: &lt;span class="hljs">"Sample webhook for API docs"&lt;/span>,
  &lt;span class="hljs">"enabled_events"&lt;/span>: [
    &lt;span class="hljs">"airdrop.created"&lt;/span>,
    &lt;span class="hljs">"airdrop.deleted"&lt;/span>,
    &lt;span class="hljs">"airdrop.updated"&lt;/span>,
    &lt;span class="hljs">"collection.created"&lt;/span>,
    &lt;span class="hljs">"collection.deleted"&lt;/span>,
    &lt;span class="hljs">"collection.updated"&lt;/span>,
    &lt;span class="hljs">"contact.created"&lt;/span>,
    &lt;span class="hljs">"contact.deleted"&lt;/span>,
    &lt;span class="hljs">"contact.updated"&lt;/span>,
    &lt;span class="hljs">"mint.created"&lt;/span>,
    &lt;span class="hljs">"mint.fulfilled"&lt;/span>,
    &lt;span class="hljs">"mint.updated"&lt;/span>,
    &lt;span class="hljs">"mint_link.created"&lt;/span>,
    &lt;span class="hljs">"mint_link.deleted"&lt;/span>,
    &lt;span class="hljs">"mint_link.updated"&lt;/span>,
    &lt;span class="hljs">"product.created"&lt;/span>,
    &lt;span class="hljs">"product.deleted"&lt;/span>,
    &lt;span class="hljs">"product.updated"&lt;/span>,
  ],
  &lt;span class="hljs">"metadata"&lt;/span>: {},
  &lt;span class="hljs">"url"&lt;/span>: &lt;span class="hljs">"https://api.example.com/webhook"&lt;/span>
}
&lt;/code>&lt;/pre>

The webhook object

&lt;h1>Create a webhook&lt;/h1>&lt;p>A webhook must have a url and a list of enabled events. You can also create webhooks in the webhooks settings section of the dashboard.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>The status of the webhook.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>An optional description of what the webhook is used for.&lt;/td>&lt;/tr>&lt;tr>&lt;td>enabled_events&lt;/td>&lt;td>true&lt;/td>&lt;td>array&lt;/td>&lt;td>The list of events to enable for this endpoint. ['*'] indicates that all events are enabled.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>dict&lt;/td>&lt;td>Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>The URL of the webhook endpoint.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>The status of the webhook.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>An optional description of what the webhook is used for.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>enabled_events&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / array&lt;/span> &lt;br/>&lt;span>The list of events to enable for this endpoint. ['*'] indicates that all events are enabled.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">dict&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>The URL of the webhook endpoint.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns the webhook object with the secret field populated&lt;/p>

Create a webhook

&lt;h1>List all webhooks&lt;/h1>&lt;p>Returns a list of your webhooks.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>The status of the webhook.&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination.&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>The status of the webhook.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a data property that contains an array of up to page_size webhooks. Each entry in the array is a separate webhook object. If no more webhooks are available, the resulting array will be empty. This request should never raise an error.&lt;/p>

List all webhooks

&lt;h1>Retrieve a webhook&lt;/h1>&lt;p>Retrieves the webhook with the given ID.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>Returns a webhook if a valid webhook ID was provided. Raises an error otherwise.&lt;/p>

Retrieve a webhook

&lt;h1>Update a webhook&lt;/h1>&lt;p>Updates the webhook. You may edit the &lt;code>url&lt;/code>, the list of &lt;code>enabled_events&lt;/code>, or whether or not your webhook is &lt;code>active&lt;/code>.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0px;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>active&lt;/td>&lt;td>false&lt;/td>&lt;td>boolean&lt;/td>&lt;td>The status of the webhook.&lt;/td>&lt;/tr>&lt;tr>&lt;td>description&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>An optional description of what the webhook is used for.&lt;/td>&lt;/tr>&lt;tr>&lt;td>enabled_events&lt;/td>&lt;td>false&lt;/td>&lt;td>array&lt;/td>&lt;td>The list of events to enable for this endpoint. ['*'] indicates that all events are enabled.&lt;/td>&lt;/tr>&lt;tr>&lt;td>metadata&lt;/td>&lt;td>false&lt;/td>&lt;td>dict&lt;/td>&lt;td>Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.&lt;/td>&lt;/tr>&lt;tr>&lt;td>url&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>The URL of the webhook endpoint.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="83c110db-ca37-40d8-9a08-f047a57c1ccc-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>active&lt;/b> &lt;span style="font-size: .7em;">boolean&lt;/span> &lt;br/>&lt;span>The status of the webhook.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>description&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>An optional description of what the webhook is used for.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>enabled_events&lt;/b> &lt;span style="font-size: .7em;">array&lt;/span> &lt;br/>&lt;span>The list of events to enable for this endpoint. ['*'] indicates that all events are enabled.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>metadata&lt;/b> &lt;span style="font-size: .7em;">dict&lt;/span> &lt;br/>&lt;span>Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>url&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>The URL of the webhook endpoint.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;figure class="table ck-widget ck-widget_with-selection-handle response-request-box" contenteditable="false">&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>The updates webhook object if successful. Otherwise, this call raises an error.&lt;/p>

Update a webhook

&lt;h1>Delete a webhook&lt;/h1>&lt;p>Deletes the webhook.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;p>No parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p class="response-desc-string">An object with the deleted webhook's ID. Otherwise, this call raises an error, such as if the webhook has already been deleted.&lt;/p>

Delete a webhook

Webhooks

&lt;h1>Search data&lt;/h1>&lt;p>Returns a list of your data matching the search parameters.&lt;/p>&lt;p>&nbsp;&lt;/p>&lt;h3>Parameters&lt;/h3>&lt;figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false">&lt;table class="request-editor-view" style="border-width:0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request">&lt;tbody>&lt;tr>&lt;td>Title&lt;/td>&lt;td>Required?&lt;/td>&lt;td>Type&lt;/td>&lt;td>Description&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_num&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A cursor for use in pagination.&lt;/td>&lt;/tr>&lt;tr>&lt;td>page_size&lt;/td>&lt;td>false&lt;/td>&lt;td>integer&lt;/td>&lt;td>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/td>&lt;/tr>&lt;tr>&lt;td>search_type&lt;/td>&lt;td>true&lt;/td>&lt;td>string&lt;/td>&lt;td>&lt;p>Enum representing the search type. Must be one of the following:&lt;/p>&lt;ul>&lt;li>search_airdrops&lt;/li>&lt;li>search_contacts&lt;/li>&lt;li>search_products&lt;/li>&lt;li>aggregate_tags&lt;/li>&lt;li>count_segment_contacts&lt;/li>&lt;li>list_segment_contacts&lt;/li>&lt;li>mint_report&lt;/li>&lt;li>usage_stats&lt;/li>&lt;/ul>&lt;/td>&lt;/tr>&lt;tr>&lt;td>query&lt;/td>&lt;td>false&lt;/td>&lt;td>string&lt;/td>&lt;td>A string to match for the search_type.&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;table style="border: 0;" id="58d534c7-bbe5-4373-8cf2-4c4c3bf302de-request" contenteditable="false" class="request-publish-view">&lt;tbody>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_num&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A cursor for use in pagination.&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>page_size&lt;/b> &lt;span style="font-size: .7em;">integer&lt;/span> &lt;br/>&lt;span>A limit on the number of object to be returned. Limit can range between 1 and 100&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>search_type&lt;/b> &lt;span style="font-size: .7em;">&lt;span style="color: #ec0000; font-size: .7em;">REQUIRED&lt;/span> / string&lt;/span> &lt;br/>&lt;span>&lt;p>Enum representing the search type. Must be one of the following:&lt;/p>&lt;ul>&lt;li>search_airdrops&lt;/li>&lt;li>search_contacts&lt;/li>&lt;li>search_products&lt;/li>&lt;li>aggregate_tags&lt;/li>&lt;li>count_segment_contacts&lt;/li>&lt;li>list_segment_contacts&lt;/li>&lt;li>mint_report&lt;/li>&lt;li>usage_stats&lt;/li>&lt;/ul>&lt;/span>&lt;/td>&lt;/tr>&lt;tr>&lt;td class="ck-editor__editable ck-editor__nested-editable" contenteditable="false" style="border: 0; border-top: 1px solid #bfbfbf50; padding-left: 0;">&lt;b>query&lt;/b> &lt;span style="font-size: .7em;">string&lt;/span> &lt;br/>&lt;span>A string to match for the search_type.&lt;/span>&lt;/td>&lt;/tr>&lt;/tbody>&lt;/table>&lt;/figure>&lt;p>&nbsp;&lt;/p>&lt;h3>Returns&lt;/h3>&lt;p>A dictionary with a data property that contains an array of up to page_size objects. Each entry in the array is a separate object. If no more objects are available, the resulting array will be empty. This request should never raise an error unless an invalid parameter is provided.&lt;/p>

Powered by Theneo