profiles

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-profiles"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/5378c6e4-7f93-4868-ad25-407466520de8/social-card.svg?v=3e7ae33eec8b" alt="profiles" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/v1/profiles

Parameters

qstringquery
tagstringquery
tagsAnystringquery
tagsAllstringquery
listIdstringquery
emailstringquery
phonestringquery
createdSincestringquery
createdBeforestringquery
updatedSincestringquery
updatedBeforestringquery
attrKeystringquery
attrOpstringquery
eq | contains | gt | lt = eq
attrValuestringquery
vipstringquery
true | false
consentStatusstringquery
granted | revoked | pending_confirmation | none
consentChannelstringquery
email | sms | whatsapp | push | postcard
consentSincestringquery
topicIdstringquery
countrystringquery
regionstringquery
citystringquery
segmentIdstringquery
eventNamestringquery
eventSincestringquery
eventBeforestringquery
sourcestringquery
archivedstringquery
only | include
sortstringquery
newest | oldest = newest
limitintegerquery
= 50
cursorstringquery

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/profiles" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "emailPrimary": "string",
      "phonePrimary": "string",
      "firstName": "string",
      "lastName": "string",
      "timezone": "string",
      "locale": "string",
      "country": "string",
      "city": "string",
      "region": "string",
      "source": "string",
      "lifecycleStage": "string",
      "ownerUserId": "string",
      "attributes": {},
      "tags": [
        "string"
      ],
      "mergedIntoId": "string",
      "archivedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "consentIgnored": [
        "email"
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
emailPrimarystringrequired
phonePrimarystringrequired
firstNamestringrequired
lastNamestringrequired
timezonestringrequired
localestringrequired
countrystringrequired
citystringrequired
regionstringrequired
sourcestringrequired
lifecycleStagestringrequired
ownerUserIdstringrequired
attributesobjectrequired
tagsstring[]required
mergedIntoIdstringrequired
archivedAtstring
createdAtstringrequired
updatedAtstringrequired
consentIgnoredstring[]
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/profiles

POSThttps://hermetica.15.204.158.166.sslip.io/v1/profiles

Request body

application/json
identifiersobjectrequired
Show child parameters
emailstring
phonestring
externalIdstring
anonymousIdstring
attributesobject
standardobject
Show child parameters
firstNamestring
lastNamestring
timezonestring
localestring
countrystring
citystring
regionstring
lifecycleStagestring
ownerUserIdstring
sourcestring
= api
matchAttributestring
unsubscribedboolean
true
subscriptionsobject
Show child parameters
emailstring
subscribed | unsubscribed
smsstring
subscribed | unsubscribed
legalBasisstring
consent | legitimate_interest | contract | other
tagsstring[]
{
  "identifiers": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "anonymousId": "string"
  },
  "attributes": {},
  "standard": {
    "firstName": "string",
    "lastName": "string",
    "timezone": "string",
    "locale": "string",
    "country": "string",
    "city": "string",
    "region": "string",
    "lifecycleStage": "string",
    "ownerUserId": "string"
  },
  "source": "api",
  "matchAttribute": "string",
  "unsubscribed": true,
  "subscriptions": {
    "email": "subscribed",
    "sms": "subscribed",
    "legalBasis": "consent"
  },
  "tags": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/profiles" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identifiers":{"email":"string","phone":"string","externalId":"string","anonymousId":"string"},"attributes":{},"standard":{"firstName":"string","lastName":"string","timezone":"string","locale":"string","country":"string","city":"string","region":"string","lifecycleStage":"string","ownerUserId":"string"},"source":"api","matchAttribute":"string","unsubscribed":true,"subscriptions":{"email":"subscribed","sms":"subscribed","legalBasis":"consent"},"tags":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "emailPrimary": "string",
  "phonePrimary": "string",
  "firstName": "string",
  "lastName": "string",
  "timezone": "string",
  "locale": "string",
  "country": "string",
  "city": "string",
  "region": "string",
  "source": "string",
  "lifecycleStage": "string",
  "ownerUserId": "string",
  "attributes": {},
  "tags": [
    "string"
  ],
  "mergedIntoId": "string",
  "archivedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "consentIgnored": [
    "email"
  ]
}
Schema
idstringrequired
emailPrimarystringrequired
phonePrimarystringrequired
firstNamestringrequired
lastNamestringrequired
timezonestringrequired
localestringrequired
countrystringrequired
citystringrequired
regionstringrequired
sourcestringrequired
lifecycleStagestringrequired
ownerUserIdstringrequired
attributesobjectrequired
tagsstring[]required
mergedIntoIdstringrequired
archivedAtstring
createdAtstringrequired
updatedAtstringrequired
consentIgnoredstring[]
4XX Default Response

Same as 4XX · GET /v1/profiles

5XX Default Response

Same as 4XX · GET /v1/profiles

POSThttps://hermetica.15.204.158.166.sslip.io/v1/profiles/upsert

Request body

application/json
identifiersobjectrequired
Show child parameters
emailstring
phonestring
externalIdstring
anonymousIdstring
attributesobject
standardobject
Show child parameters
firstNamestring
lastNamestring
timezonestring
localestring
countrystring
citystring
regionstring
lifecycleStagestring
ownerUserIdstring
sourcestring
= api
matchAttributestring
unsubscribedboolean
true
subscriptionsobject
Show child parameters
emailstring
subscribed | unsubscribed
smsstring
subscribed | unsubscribed
legalBasisstring
consent | legitimate_interest | contract | other
tagsstring[]
{
  "identifiers": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "anonymousId": "string"
  },
  "attributes": {},
  "standard": {
    "firstName": "string",
    "lastName": "string",
    "timezone": "string",
    "locale": "string",
    "country": "string",
    "city": "string",
    "region": "string",
    "lifecycleStage": "string",
    "ownerUserId": "string"
  },
  "source": "api",
  "matchAttribute": "string",
  "unsubscribed": true,
  "subscriptions": {
    "email": "subscribed",
    "sms": "subscribed",
    "legalBasis": "consent"
  },
  "tags": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/profiles/upsert" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"identifiers":{"email":"string","phone":"string","externalId":"string","anonymousId":"string"},"attributes":{},"standard":{"firstName":"string","lastName":"string","timezone":"string","locale":"string","country":"string","city":"string","region":"string","lifecycleStage":"string","ownerUserId":"string"},"source":"api","matchAttribute":"string","unsubscribed":true,"subscriptions":{"email":"subscribed","sms":"subscribed","legalBasis":"consent"},"tags":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "profile": {
    "id": "string",
    "emailPrimary": "string",
    "phonePrimary": "string",
    "firstName": "string",
    "lastName": "string",
    "timezone": "string",
    "locale": "string",
    "country": "string",
    "city": "string",
    "region": "string",
    "source": "string",
    "lifecycleStage": "string",
    "ownerUserId": "string",
    "attributes": {},
    "tags": [
      "string"
    ],
    "mergedIntoId": "string",
    "archivedAt": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z",
    "consentIgnored": [
      "email"
    ]
  },
  "created": true,
  "conflicts": [
    "string"
  ]
}
Schema
profileobjectrequired
Show child parameters
idstringrequired
emailPrimarystringrequired
phonePrimarystringrequired
firstNamestringrequired
lastNamestringrequired
timezonestringrequired
localestringrequired
countrystringrequired
citystringrequired
regionstringrequired
sourcestringrequired
lifecycleStagestringrequired
ownerUserIdstringrequired
attributesobjectrequired
tagsstring[]required
mergedIntoIdstringrequired
archivedAtstring
createdAtstringrequired
updatedAtstringrequired
consentIgnoredstring[]
createdbooleanrequired
conflictsstring[]required
4XX Default Response

Same as 4XX · GET /v1/profiles

5XX Default Response

Same as 4XX · GET /v1/profiles

GEThttps://hermetica.15.204.158.166.sslip.io/v1/profiles/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/profiles/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/profiles

4XX Default Response

Same as 4XX · GET /v1/profiles

5XX Default Response

Same as 4XX · GET /v1/profiles

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/profiles/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/profiles/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "removed": [
    {
      "type": "string",
      "value": "string"
    }
  ]
}
Schema
removedobject[]required
Show child parameters
typestringrequired
valuestringrequired
4XX Default Response

Same as 4XX · GET /v1/profiles

5XX Default Response

Same as 4XX · GET /v1/profiles

Updated