Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Overview
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create a Contact Profile
Creates a Contact Profile.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/profiles \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"profile": {
"prevent_data_collection": true,
"accepted_gdpr": true,
"privacy_policy": {},
"tasks": [
"buyer"
],
"memories": [
{
"id": "123456",
"timestamp": "2024-09-23T08:37:00Z",
"text": "This is a memory."
}
],
"firstname": "Max",
"lastname": "Mustermann",
"email": "jsmith@example.com",
"profilepic": ""
},
"active": true,
"contactIds": [
"mail@example.com"
],
"projectId": "<string>"
}
'{
"profile": {
"prevent_data_collection": true,
"accepted_gdpr": true,
"privacy_policy": {},
"tasks": [
"buyer"
],
"memories": [
{
"id": "123456",
"timestamp": "2024-09-23T08:37:00Z",
"text": "This is a memory."
}
],
"firstname": "Max",
"lastname": "Mustermann",
"email": "jsmith@example.com",
"profilepic": ""
},
"active": true,
"contactIds": [
"mail@example.com"
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Body
Response
Returns Profile object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
Show child attributes
Show child attributes
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/profiles \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"profile": {
"prevent_data_collection": true,
"accepted_gdpr": true,
"privacy_policy": {},
"tasks": [
"buyer"
],
"memories": [
{
"id": "123456",
"timestamp": "2024-09-23T08:37:00Z",
"text": "This is a memory."
}
],
"firstname": "Max",
"lastname": "Mustermann",
"email": "jsmith@example.com",
"profilepic": ""
},
"active": true,
"contactIds": [
"mail@example.com"
],
"projectId": "<string>"
}
'{
"profile": {
"prevent_data_collection": true,
"accepted_gdpr": true,
"privacy_policy": {},
"tasks": [
"buyer"
],
"memories": [
{
"id": "123456",
"timestamp": "2024-09-23T08:37:00Z",
"text": "This is a memory."
}
],
"firstname": "Max",
"lastname": "Mustermann",
"email": "jsmith@example.com",
"profilepic": ""
},
"active": true,
"contactIds": [
"mail@example.com"
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}