{ "info": { "description": "\n External API that allows you to create, update, and delete org profiles\n ", "title": "Talque Org Profile Webhook API", "version": "1.0.0" }, "paths": { "/webhook/org/{orgId}/profile/create": { "post": { "summary": "Create an org profile via webhook", "description": "Creates a new org profile in the organization. If an email is provided, the profile is linked to the matching account. If email is null, a phony (unlinked) profile is created.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "nullable": true, "description": "Email address of the account to link. Null creates a phony profile." }, "locale": { "type": "string", "description": "The locale of the profile (e.g. EN_US, DE_DE)." }, "firstName": { "type": "string", "description": "The first name." }, "lastName": { "type": "string", "description": "The last name." }, "jobTitle": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated job title." }, "companyName": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated company name." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated location." }, "bio": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated biography." }, "bioIsMarkdown": { "type": "boolean", "description": "Whether the bio is formatted as Markdown." }, "note": { "type": "string", "description": "An internal note visible only to admins." }, "isHighlight": { "type": "boolean", "description": "Whether the profile is highlighted." }, "manualOrder": { "type": "integer", "nullable": true, "description": "Optional sort order for speakers. Lower values appear first; null means no preference (sorts last)." }, "isLocal": { "type": "boolean", "description": "Whether the profile is a local participant." }, "isPublished": { "type": "boolean", "description": "Whether the profile is published." }, "isVip": { "type": "boolean", "description": "Whether the profile is a VIP." }, "badges": { "type": "array", "items": { "type": "string" }, "description": "List of badge identifiers." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of category identifiers." }, "photo": { "type": "string", "nullable": true, "description": "Temporary file identifier for the profile photo. Null to omit." }, "isPhotoLocked": { "type": "boolean", "description": "Whether the profile photo is locked (cannot be changed by the user)." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier for the profile." }, "website": { "type": "string", "description": "Website URL." }, "facebook": { "type": "string", "description": "Facebook profile URL." }, "linkedin": { "type": "string", "description": "LinkedIn profile URL." }, "twitter": { "type": "string", "description": "Twitter/X handle or URL." }, "xing": { "type": "string", "description": "Xing profile URL." }, "instagram": { "type": "string", "description": "Instagram profile URL." }, "youtube": { "type": "string", "description": "YouTube channel URL." } }, "required": [ "email", "locale", "firstName", "lastName", "jobTitle", "companyName", "location", "bio", "note", "photo" ] } } } }, "responses": { "200": { "description": "Profile successfully created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "atime": { "type": "integer", "description": "The server time at which the request was processed (Unix timestamp, milliseconds)." }, "orgId": { "type": "string", "description": "The unique ID of the organization." }, "profile": { "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique ID of the profile." }, "firstName": { "type": "string", "description": "The first name of the profile." }, "lastName": { "type": "string", "description": "The last name of the profile." }, "jobTitle": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated job title." }, "companyName": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated company name." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated location." }, "bio": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated biography." }, "bioHtml": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "description": "Per-locale rendered HTML of the bio. Null when bioIsMarkdown is false." }, "accountEmail": { "type": "string", "nullable": true, "description": "Email address of the linked account." }, "accountAlias": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Email aliases of the linked account." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Category identifiers assigned to the profile." }, "categoryOrigins": { "type": "array", "items": { "type": "object" }, "description": "Origins of the assigned categories." }, "emailLog": { "type": "array", "items": { "type": "object" }, "description": "Log of emails sent to this profile." }, "note": { "type": "string", "description": "An internal note visible only to admins." }, "isPhony": { "type": "boolean", "description": "Whether this profile has no associated registered account." }, "isSpeaker": { "type": "boolean", "description": "Whether the profile is a speaker." }, "isPublished": { "type": "boolean", "description": "Whether the profile is published." }, "isVip": { "type": "boolean", "description": "Whether the profile is a VIP." }, "isHighlight": { "type": "boolean", "description": "Whether the profile is highlighted." }, "manualOrder": { "type": "integer", "nullable": true, "description": "Optional sort order for speakers. Lower values appear first; null means no preference (sorts last)." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier." }, "mtime": { "type": "integer", "description": "The last modification time as a Unix timestamp (milliseconds)." }, "ctime": { "type": "integer", "description": "The creation time as a Unix timestamp (milliseconds)." } }, "required": [ "profileId", "isSpeaker", "isPublished" ] } }, "required": [ "atime", "orgId", "profile" ] } } } }, "400": { "description": "Bad request (e.g., missing required fields or invalid data)." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Organization not found." } } } }, "/webhook/org/{orgId}/profile/update": { "post": { "summary": "Update an org profile via webhook", "description": "Updates fields on an existing org profile. Only fields that are present in the request body are updated.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique ID of the profile to update." }, "email": { "type": "string", "nullable": true, "description": "New email address (only settable on phony profiles)." }, "locale": { "type": "string", "description": "The locale of the profile (e.g. EN_US, DE_DE)." }, "firstName": { "type": "string", "description": "The first name." }, "lastName": { "type": "string", "description": "The last name." }, "jobTitle": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated job title." }, "companyName": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated company name." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated location." }, "bio": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated biography." }, "bioIsMarkdown": { "type": "boolean", "description": "Whether the bio is formatted as Markdown." }, "note": { "type": "string", "description": "An internal note visible only to admins." }, "isHighlight": { "type": "boolean", "description": "Whether the profile is highlighted." }, "manualOrder": { "type": "integer", "nullable": true, "description": "Optional sort order for speakers. Lower values appear first; null means no preference (sorts last)." }, "isLocal": { "type": "boolean", "description": "Whether the profile is a local participant." }, "isPublished": { "type": "boolean", "description": "Whether the profile is published." }, "isVip": { "type": "boolean", "description": "Whether the profile is a VIP." }, "badges": { "type": "array", "items": { "type": "string" }, "description": "List of badge identifiers." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of category identifiers." }, "photo": { "type": "string", "description": "Temporary file identifier for the profile photo." }, "deletePhoto": { "type": "boolean", "description": "Set to true to remove the existing profile photo." }, "isPhotoLocked": { "type": "boolean", "description": "Whether the profile photo is locked." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier for the profile." }, "force": { "type": "boolean", "description": "Force removal of locked categories." }, "website": { "type": "string", "description": "Website URL." }, "facebook": { "type": "string", "description": "Facebook profile URL." }, "linkedin": { "type": "string", "description": "LinkedIn profile URL." }, "twitter": { "type": "string", "description": "Twitter/X handle or URL." }, "xing": { "type": "string", "description": "Xing profile URL." }, "instagram": { "type": "string", "description": "Instagram profile URL." }, "youtube": { "type": "string", "description": "YouTube channel URL." } }, "required": [ "profileId" ], "description": "The profileId is required. All other fields are optional and only updated when provided." } } } }, "responses": { "200": { "description": "Profile successfully updated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "atime": { "type": "integer", "description": "The server time at which the request was processed (Unix timestamp, milliseconds)." }, "profile": { "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique ID of the profile." }, "firstName": { "type": "string", "description": "The first name of the profile." }, "lastName": { "type": "string", "description": "The last name of the profile." }, "jobTitle": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated job title." }, "companyName": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated company name." }, "location": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated location." }, "bio": { "$schema": "http://json-schema.org/draft-04/schema", "type": "object", "properties": { "DE_DE": { "type": "string" }, "EN_US": { "type": "string" }, "FR_FR": { "type": "string" }, "ES_ES": { "type": "string" }, "PT_PT": { "type": "string" }, "ZH_CN": { "type": "string" }, "UK_UA": { "type": "string" }, "AR_EG": { "type": "string" }, "RU_RU": { "type": "string" }, "FA_IR": { "type": "string" }, "NL_NL": { "type": "string" } }, "additionalProperties": false, "description": "The translated biography." }, "bioHtml": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true, "description": "Per-locale rendered HTML of the bio. Null when bioIsMarkdown is false." }, "accountEmail": { "type": "string", "nullable": true, "description": "Email address of the linked account." }, "accountAlias": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Email aliases of the linked account." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Category identifiers assigned to the profile." }, "categoryOrigins": { "type": "array", "items": { "type": "object" }, "description": "Origins of the assigned categories." }, "emailLog": { "type": "array", "items": { "type": "object" }, "description": "Log of emails sent to this profile." }, "note": { "type": "string", "description": "An internal note visible only to admins." }, "isPhony": { "type": "boolean", "description": "Whether this profile has no associated registered account." }, "isSpeaker": { "type": "boolean", "description": "Whether the profile is a speaker." }, "isPublished": { "type": "boolean", "description": "Whether the profile is published." }, "isVip": { "type": "boolean", "description": "Whether the profile is a VIP." }, "isHighlight": { "type": "boolean", "description": "Whether the profile is highlighted." }, "manualOrder": { "type": "integer", "nullable": true, "description": "Optional sort order for speakers. Lower values appear first; null means no preference (sorts last)." }, "extId": { "type": "string", "nullable": true, "description": "Optional external identifier." }, "mtime": { "type": "integer", "description": "The last modification time as a Unix timestamp (milliseconds)." }, "ctime": { "type": "integer", "description": "The creation time as a Unix timestamp (milliseconds)." } }, "required": [ "profileId", "isSpeaker", "isPublished" ] } }, "required": [ "atime", "profile" ] } } } }, "400": { "description": "Bad request (e.g., missing profileId or invalid data)." }, "401": { "description": "Unauthorized." }, "403": { "description": "Forbidden." }, "404": { "description": "Organization or profile not found." } } } }, "/webhook/org/{orgId}/profile/delete": { "post": { "summary": "Delete an org profile via webhook", "description": "Permanently removes an org profile from the organization.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The unique identifier of the organization." }, { "name": "X-TQ-CLIENT-ID", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client ID for authentication." }, { "name": "X-TQ-SECRET", "in": "header", "required": true, "schema": { "type": "string" }, "description": "The API client secret for authentication." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "profileId": { "type": "string", "description": "The unique ID of the profile to remove." } }, "required": [ "profileId" ] } } } }, "responses": { "200": { "description": "Profile successfully removed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates if the profile was successfully removed." } }, "required": [ "success" ] } } } }, "400": { "description": "Bad request (e.g., missing profileId or invalid orgId)." }, "401": { "description": "Unauthorized. Missing or invalid X-TQ-CLIENT-ID or X-TQ-SECRET headers." }, "403": { "description": "Forbidden. The API client does not have permission for this organization." }, "404": { "description": "Organization or profile not found." } } } } }, "openapi": "3.0.3" }