Skip to content

Profiles API

API endpoints for managing customer profiles.

Navigation

Use the table of contents on the right to jump to specific endpoints.


GET /profiles/{profileId}/notes

GET
/profiles/{profileId}/notes

Authorizations

Bearer

JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'

Type
API Key (header: Authorization)
+
Basic

Basic Authentication with username and password.

Type
HTTP (basic)

Parameters

Path Parameters

profileId*
Type
integer
Required
Format
"int32"

Responses

OK

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

POST /profiles/{profileId}/note

POST
/profiles/{profileId}/note

Authorizations

Bearer

JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'

Type
API Key (header: Authorization)
+
Basic

Basic Authentication with username and password.

Type
HTTP (basic)

Parameters

Path Parameters

profileId*
Type
integer
Required
Format
"int32"

Request Body

JSON
{
"profileId": 0,
"content": "string"
}

Responses

OK

Playground

Authorization
Variables
Key
Value
Body

Samples

cURL
JavaScript
PHP
Python

PUT /profiles/{profileId}/note/{noteId}

PUT
/profiles/{profileId}/note/{noteId}

Authorizations

Bearer

JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'

Type
API Key (header: Authorization)
+
Basic

Basic Authentication with username and password.

Type
HTTP (basic)

Parameters

Path Parameters

profileId*
Type
integer
Required
Format
"int32"
noteId*
Type
integer
Required
Format
"int32"

Request Body

JSON
{
"profileId": 0,
"content": "string"
}

Responses

OK

Playground

Authorization
Variables
Key
Value
Body

Samples

cURL
JavaScript
PHP
Python

DELETE /profiles/{profileId}/note/{noteId}

DELETE
/profiles/{profileId}/note/{noteId}

Authorizations

Bearer

JWT Authorization header using the Bearer scheme. \r\n\r\n
Enter 'Bearer' [space] and then your token in the text input below.
\r\n\r\nExample: 'Bearer 12345abcdef'

Type
API Key (header: Authorization)
+
Basic

Basic Authentication with username and password.

Type
HTTP (basic)

Parameters

Path Parameters

profileId*
Type
integer
Required
Format
"int32"
noteId*
Type
integer
Required
Format
"int32"

Responses

OK

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python

Powered by VitePress OpenAPI