Create

Create vendor

POST https://www.talque.com/webhook/org/:orgId/vendor/create

This endpoint allows you to create vendor. The parameters marked with COMING SOON: are not yet implemented.

You can find a basic example at https://github.com/talque/webhook-samples/blob/main/src/vendor/create.py

Request Body

Name
Type
Description

extId

string | null

External (customer-specific) ID to reference the vendor Can be null. Must not be already used by other vendor.

buttons

object

Custom button on the vendor profile

exhibitor

string | null

The exhibitor category. Can be null for "not set".

sponsor

string | null

The sponsor category. Can be null for "not set"

name*

object

A translated text representing the display name that is shown on the profile

adminName

object | null

A translated text for an internal (admin-only) name for the vendor

description

object

A translated text representing description. Markdown-formatted.

photo

string | null

A temp file id (see the file upload section) for the logo

backgroundImage

string | null

A temp file id for the banner image

admins

string[]

A list of account ids of admins

staff

string[]

Company staff members as a list of profile ids (existing profile required)

staffPending

string[]

Company staff members that have not joined yet as a list of account ids

staffCanMeet

boolean

COMING SOON: A boolean value representing if staff can meet

staffCanChat

boolean

COMING SOON: A boolean value representing if staff can chat

hall

string

A string value representing hall

booth

string

A string value representing booth

address

string

A string value representing address

zipCode

string

Zip code of the address

city

object

A translated text of city

country

string

A value of country enum (ISO 3166-1 alpha-2)

website

string

A company website URL

email

string

Company contact e-mail address

phone

string

Company contact phone number

facebook

string

Company Facebook profile URL

linkedin

string

Company LinkedIn profile URL

twitter

string

Company Twitter profile URL

xing

string

Company Xing profile URL

instagram

string

Company Instagram profile URL

youtube

string

Company Youtube profile URL

isSelfSelect

boolean

COMING SOON: Can normal participants list themselves as company staff (default: false)

locale

string

A string indicating one of the possible locale enum values for the company's default profile locale

video

object

A translated text URL of a video to display on the company profile

gallery

array

An array of gallery change objects

portfolio

array

An array of portfolio change objects

marks

string[]

A list of vendor tags

perks

string[]

An array of perk identifiers, the packages that are enabled for this vendor

main

string[]

An array of vendor IDs. Marks the newly-created vendor as sub-exhibitor.

customData

object

COMING SOON: An object of custom data

{
    "vendorId": "vgOQ8Kv2WM41Sz1fEbiB",
    "vendor": {
        "rating": null,
        "photoMedium": "/_ah/img/encoded_gs_file:cGhvdG8udGFscXVlLmNvbS92ZW5kb3IvdmdPUThLdjJXTTQxU3oxZkViaUIvMTYyNzMxMzE0MC5qcGc=",
        "instagram": "https://instagram.com/foo",
        "vendorId": "vgOQ8Kv2WM41Sz1fEbiB",
        "isVipSpot": false,
        "photo": "/_ah/img/encoded_gs_file:cGhvdG8udGFscXVlLmNvbS92ZW5kb3IvdmdPUThLdjJXTTQxU3oxZkViaUIvMTYyNzMxMzE0MC5qcGc=",
        "twitter": "https://www.twitter.com/profile",
        "descriptionSource": {
            "DE_DE": "Deutsche Description",
            "EN_US": "English Descripion"
        },
        "linkedin": "https://www.linkedin.com/profile",
        "isPublished": true,
        "vipAnswerRequired": true,
        "video": {
            "videoType": "YOUTUBE",
            "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
            "size": {
                "width": 640,
                "height": 480
            },
            "youtubeId": "dQw4w9WgXcQ",
            "urlSource": {
                "EN_US": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
            }
        },
        "booth": "24C",
        "mtime": 1627313139980,
        "portfolio": {
            "items": [
                {
                    "preview": {
                        "mimeType": "PDF",
                        "fileType": "BINARY",
                        "fileId": "8qmoq1k4XJ3lSlKYUvYx",
                        "name": "fox_and_dog.txt",
                        "size": 10716
                    },
                    "portfolioItemType": "DOCUMENT",
                    "thumbnail": null,
                    "title": "a story about fox and dog"
                }
            ],
            "config": {
                "document": 2,
                "limit": 2
            }
        },
        "staff": [
            "7HLclAhAOwp3UUhzqUFK",
            "R0RVGJmBbedR753hGkaZ"
        ],
        "city": "One city",
        "xing": "https://xing.de/foo",
        "name": "Vendor Name",
        "vipQuestionSource": {
            "EN_US": "Why do you want to meet us?"
        },
        "admins": [
            "trDq1ZVvms1twW5h0RkX",
            "6FXo0BY6bXvgCJffnaG8",
            "oCtGpLmZjNF9GioZUXbV"
        ],
        "hall": "7",
        "buttons": [],
        "locale": "DE_DE",
        "subjects": [
            "op",
            "ad"
        ],
        "backgroundImage": "/_ah/img/encoded_gs_file:cGhvdG8udGFscXVlLmNvbS92ZW5kb3IvdmdPUThLdjJXTTQxU3oxZkViaUIvYmcvMTYyNzMxMzE0MC5qcGc=",
        "marks": [
            "internet",
            "technology"
        ],
        "vipCategories": [
            "fo"
        ],
        "main": [
            "DKIUeS9cN1V4Cm1b208U",
            "8c7I8rso53SMIwoDY56P"
        ],
        "email": "vendor@debug.foo",
        "vipSpots": [],
        "businessAreas": [],
        "website": null,
        "isInLeadList": false,
        "vendor": "exhib",
        "description": "<div class='msg_div'>\n<p class='msg_p'>English Descripion</p>\n</div>",
        "form": {
            "instagram": null,
            "photo": null,
            "twitter": null,
            "descriptionSource": {},
            "linkedin": null,
            "mtime": 0,
            "city": null,
            "xing": null,
            "backgroundImage": null,
            "editor": null,
            "email": null,
            "website": "",
            "citySource": {},
            "description": null,
            "zipCode": null,
            "phone": null,
            "facebook": null,
            "address": null,
            "name": null,
            "country": "",
            "countrySource": null,
            "nameSource": {}
        },
        "portfolioSource": {
            "items": [
                {
                    "titleSource": {
                        "EN_US": "a story about fox and dog"
                    },
                    "preview": {
                        "mimeType": "PDF",
                        "fileType": "BINARY",
                        "fileId": "8qmoq1k4XJ3lSlKYUvYx",
                        "name": "fox_and_dog.txt",
                        "size": 10716
                    },
                    "portfolioItemType": "DOCUMENT",
                    "thumbnail": null,
                    "title": "a story about fox and dog"
                }
            ],
            "config": {
                "document": 2,
                "limit": 2
            }
        },
        "customData": {
            "data": [
                {
                    "type": "StringData",
                    "id": "iNzycByOV1bulbPt41kE",
                    "value": "Bamberg"
                }
            ]
        },
        "quota": {
            "speakerFormCredits": 2,
            "directCall": true,
            "products": [
                {
                    "count": 2,
                    "portfolio": {
                        "document": 0,
                        "limit": 0
                    },
                    "gallery": {
                        "limit": 1,
                        "embed": 0,
                        "video": 0,
                        "image": 1
                    },
                    "catalogId": "Iq014W0BMLv33srZo7D7"
                }
            ],
            "dashboard": false,
            "markLimits": [
                {
                    "limit": 2,
                    "catalogId": "Iq014W0BMLv33srZo7D7"
                }
            ],
            "leadList": {
                "profile": false,
                "portfolio": true,
                "gallery": false,
                "chat": true
            }
        },
        "zipCode": "12345",
        "phone": "555-555 5555",
        "facebook": "https://www.facebook.com/profile",
        "staffCanMeet": true,
        "vipQuestion": "Why do you want to meet us?",
        "address": "Address 1",
        "gallery": {
            "items": [
                {
                    "galleryItemType": "IMAGE",
                    "url": "/_ah/img/encoded_gs_file:ZmlsZS50YWxxdWUuY29tL29yZy9ZNTJjY1RoYk40UmpzVExsalR1NS9maWxlL3IzYXdXeHJSY1pSN3NuY0ptWE82=s0",
                    "fileType": "IMAGE",
                    "analyticsId": "f:r3awWxrRcZR7sncJmXO6",
                    "fileId": "r3awWxrRcZR7sncJmXO6"
                }
            ],
            "config": {
                "limit": 2,
                "embed": 1,
                "video": 1,
                "image": 0
            }
        },
        "needsApproval": false,
        "isSelfSelect": true,
        "hasVipSpot": false,
        "ctime": 1627313139980,
        "country": "Germany",
        "staffCanChat": false,
        "speakerFormCredits": 2,
        "citySource": {
            "EN_US": "One city"
        },
        "isSpeakerFormInvitationSent": false,
        "ownRating": null,
        "extId": null,
        "countrySource": "DE",
        "perks": [
            "N037dBZNG6lp25G0PeY2"
        ],
        "isFormInvitationSent": false,
        "nameSource": {
            "EN_US": "Vendor Name"
        },
        "isLectureFormInvitationSent": false,
        "sponsor": "bronze"
    },
    "success": true,
    "reasonEnum": "CreateVendorReason",
    "reason": "SUCCESS",
    "chat": {
        "newsCount": 0,
        "sortTime": 1627313139980,
        "newsTime": 1627313139980,
        "time": 1627313139980,
        "supersededBy": null,
        "members": [
            "trDq1ZVvms1twW5h0RkX",
            "6FXo0BY6bXvgCJffnaG8",
            "oCtGpLmZjNF9GioZUXbV"
        ],
        "isVisible": false,
        "readUntilTime": 0,
        "chatId": "VENDOR:Y52ccThbN4RjsTLljTu5-vgOQ8Kv2WM41Sz1fEbiB",
        "phoneId": null,
        "chatType": "VENDOR",
        "latest": {
            "linkId": null,
            "blurbType": "NONE",
            "preview": "",
            "accountId": "IwHSz5adZUlyreeG9Hnz",
            "time": 0
        }
    },
    "channel": {
        "notification": null,
        "messages": [
            {
                "data": {
                    "unread": {
                        "sortTimeIf": null,
                        "count": 0,
                        "sortTimeThen": null,
                        "isVisible": null,
                        "isSilent": false,
                        "time": 1627313139980,
                        "chatId": "VENDOR:Y52ccThbN4RjsTLljTu5-vgOQ8Kv2WM41Sz1fEbiB",
                        "isRepliedTo": false
                    },
                    "chatId": "VENDOR:Y52ccThbN4RjsTLljTu5-vgOQ8Kv2WM41Sz1fEbiB"
                },
                "messageType": "UNREAD"
            },
            {
                "data": {
                    "orgId": "Y52ccThbN4RjsTLljTu5",
                    "vendorIdList": [
                        "vgOQ8Kv2WM41Sz1fEbiB"
                    ]
                },
                "messageType": "VENDOR_CHANGE"
            }
        ],
        "sender": {
            "sessionId": "qujuuHd16OhN3yCPyIaa",
            "accountId": "IwHSz5adZUlyreeG9Hnz"
        },
        "sortKey": "1wD6uR8xXbE",
        "time": 1627313142293
    }
}

Example Request

{
    "instagram": "https://instagram.com/foo",
    "locale": "DE_DE",
    "photo": "ssHQRJaySt6sB9QEmKqc",
    "twitter": "https://www.twitter.com/profile",
    "linkedin": "https://www.linkedin.com/profile",
    "vipAnswerRequired": true,
    "video": {
        "EN_US": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    },
    "sponsor": "bronze",
    "portfolio": [
        {
            "action": "ADD_DOCUMENT",
            "title": {
                "EN_US": "a story about fox and dog"
            },
            "name": "fox_and_dog.txt",
            "tempFileId": "tlMjUDJqnqjZkK6zAzOO"
        }
    ],
    "staff": [
        "d37Jk6Wt7IIdGPpiu8XS",
        "7jFYeZBirx99cmAyl29o"
    ],
    "city": {
        "EN_US": "One city"
    },
    "xing": "https://xing.de/foo",
    "perks": [
        "N037dBZNG6lp25G0PeY2"
    ],
    "gallery": [
        {
            "action": "ADD_IMAGE",
            "name": "image.jpg",
            "tempFileId": "JBQBdhR6fLmQZGa4O9GN"
        }
    ],
    "backgroundImage": "7c633paDVPhchRjBXEVU",
    "marks": [
        "internet",
        "technology"
    ],
    "vipCategories": [
        "fou"
    ],
    "main": [
        "F2wZqrH36P53ZdvRE8Pz",
        "msnCrp4GhkG5z8snSU2W"
    ],
    "email": "vendor@debug.foo",
    "businessAreas": [
        "op",
        "ad"
    ],
    "vendor": "exhib",
    "description": {
        "DE_DE": "Deutsche Description",
        "EN_US": "English Descripion"
    },
    "customData": {
        "data": [
            {
                "type": "StringData",
                "id": "iNzycByOV1bulbPt41kE",
                "value": "Bamberg"
            }
        ]
    },
    "zipCode": "12345",
    "phone": "555-555 5555",
    "facebook": "https://www.facebook.com/profile",
    "staffCanMeet": true,
    "members": [
        "fQmO2drXtXN0vIl6MQ6f"
    ],
    "address": "Address 1",
    "hall": "7",
    "isSelfSelect": true,
    "name": {
        "EN_US": "Vendor Name"
    },
    "country": "DE",
    "staffCanChat": false,
    "vipQuestion": {
        "EN_US": "Why do you want to meet us?"
    },
    "admins": [
        "nIQoL0HwIMb68HX2YInh",
        "Z2qQzqi1DlED3q69X9WM",
        "lxdDKhl5eTLAjxtQCLaq"
    ],
    "orgId": "Y52ccThbN4RjsTLljTu5",
    "booth": "24C"
}

Last updated