Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Contact object represents a contact to which notifications are sent. Contact can, but doesn’t have to be linked to a user on the platform. Each contact can manage its notification preferences on a category level.
id
string
A primary identifier for the contact.
Example: CTT-1234-9876-1234
href
string
A relative reference to the object.
Example: /v1/notifications/contacts/CTT-1234-9876-1234
name
Active
A contact in this state can receive emails from the platform, depending on their preferences.
Blocked
A contact in this state will not receive the email, but the platform will generate a message.
Deleted
Deleted contacts cannot be used for notifications.
New
This is the initial status for a new contact.
string
The contact's display name.
Example: Jane Doe
string
The contact's email address.
Example: [email protected]
user
Indicates if the email belongs to a user registered on the platform.
Example:
optOuts
A list of notification categories that the contact has chosen to opt out of. By default, a contact is opted into all published categories.
Example:
status
enum
The possible values are Active
or Blocked.
audit
A reference to the Audit object.
Example:
{
"id": "CTT-1234-9876-1234",
"href": "/v1/notifications/contacts/CTT-1234-9876-1234",
"name": "Will Smith",
"email": "[email protected]",
"user": {
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "[email protected]"
},
"optOuts": [
{
"id": "NTC-1234-9876",
"href": "/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Orders"
}
],
"status": "Active",
"audit": {
"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}
}
}{
"id": "USR-3773-5838",
"href": "/accounts/users/USR-1234-9876",
"name": "Will Smith",
"email": "[email protected]"
}[
{
"id": "NTC-1234-9876",
"href": "/notifications/categories/NTC-1234-9876",
"name": "Orders",
"shortDescription": "Orders"
}
]"created": {
"at": "2023-12-14T17:28:57Z",
"by": {
"id": "UR-1234-1234-1234",
"name": "John Smith",
"icon": "/static/users/UR-1234-1234-1234.icon.svg"
},
"of": {
"id": "ACC-1234-1234",
"href": "/accounts/accounts/ACC-1234-1234",
"name": "Microsoft",
"icon": "/static/ACC-1234-1234/account.png"
}
}This object contains the following attributes:
OK
Bad Request
OK
Bad Request
Not Found
GET /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
GET /public/v1/notifications/contacts HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {},
"updated": {},
"activated": {},
"blocked": {},
"deleted": {}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}
]
}{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"activated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"blocked": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"deleted": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": {},
"updated": {},
"invitationAcceptedAt": "2025-12-14T08:21:33.917Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}POST /public/v1/notifications/contacts HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"email": "text",
"optOuts": [
{
"id": "text"
}
],
"name": "text"
}DELETE /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"activated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"blocked": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"deleted": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": {},
"updated": {},
"invitationAcceptedAt": "2025-12-14T08:21:33.917Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"activated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"blocked": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"deleted": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": {},
"updated": {},
"invitationAcceptedAt": "2025-12-14T08:21:33.917Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}PUT /public/v1/notifications/contacts/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"email": "text",
"optOuts": [
{
"id": "text"
}
],
"name": "text"
}POST /public/v1/notifications/contacts/{id}/block HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"activated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"blocked": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"deleted": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": {},
"updated": {},
"invitationAcceptedAt": "2025-12-14T08:21:33.917Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}POST /public/v1/notifications/contacts/{id}/unblock HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
{
"id": "text",
"audit": {
"created": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"updated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"activated": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"blocked": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
},
"deleted": {
"at": "2025-12-14T08:21:33.917Z",
"by": {}
}
},
"$meta": {
"omitted": [
"text"
]
},
"blockedReason": "text",
"email": "text",
"name": "text",
"optOuts": [
{
"id": "text",
"description": "text",
"name": "text",
"icon": "text",
"lastUsed": "2025-12-14T08:21:33.917Z"
}
],
"status": "text",
"userId": "text",
"user": {
"id": "text",
"audit": {
"created": {},
"updated": {},
"invitationAcceptedAt": "2025-12-14T08:21:33.917Z"
},
"$meta": {
"omitted": [
"text"
]
},
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-12-14T08:21:33.917Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"accounts": [
{
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
],
"currentAccount": {
"id": "text",
"icon": "text",
"type": "text",
"status": "text",
"name": "text"
}
}
}