All pages
Powered by GitBook
1 of 1

Loading...

Create contact

post

Creates a new contact with the provided email address. Contacts can then be subscribed to categories.

Body
emailstring · nullableOptional
idstringOptional
namestring · nullableOptional
idstringOptional
chatboolean · nullableOptional
Responses
201

Created

application/json

Represents a notification contact who can receive email notifications.

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
revisioninteger · int32Optional
namestring · nullableOptional
blockedReasonstring · nullableOptional
emailstringOptional
statusstringOptional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
idstringOptional
revisioninteger · int32Optional
chatbooleanOptional
idstringOptional
namestringOptional
revisioninteger · int32Optional
descriptionstringOptional

Gets or sets the description of the category.

lastUsedstring · date-time · nullableOptional

Gets or sets the timestamp of when this category was last used to send a notification.

idstringOptional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
atstring · date-time · nullableOptional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
invitationAcceptedAtstring · date-time · nullableOptional
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
emailstringOptional
statusstringOptional
prefixstring · nullableOptional
numberstring · nullableOptional
firstNamestringOptional
lastNamestringOptional
lastLoginAtstring · date-time · nullableOptional
cultureCodestringOptional
dateFormatstring · nullableOptional
languageCodestringOptional
decimalSeparatorstringOptional
groupSeparatorstringOptional
timeFormatstring · nullableOptional
timeZonestring · nullableOptional
objectTypesstring[]Optional
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
idstringOptional
namestringOptional
iconstring · nullableOptional
revisioninteger · int32Optional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
400

Bad Request

application/json
typestring · nullableOptional
titlestring · nullableOptional
statusinteger · int32 · nullableOptional
detailstring · nullableOptional
instancestring · nullableOptional
Other propertiesanyOptional
post/public/v1/notifications/contacts
POST /public/v1/notifications/contacts HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "email": "text",
  "optOuts": [
    {
      "id": "text"
    }
  ],
  "name": "text",
  "directories": [
    {
      "id": "text"
    }
  ],
  "chat": true
}
{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "activated": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "blocked": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-01-01T00:00:00.000Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "name": "text",
  "blockedReason": "text",
  "email": "text",
  "status": "text",
  "identity": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1
  },
  "directories": [
    {
      "id": "text",
      "revision": 1
    }
  ],
  "chat": true,
  "optOuts": [
    {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "lastUsed": "2026-01-01T00:00:00.000Z"
    }
  ],
  "user": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "updated": {
        "at": "2026-01-01T00:00:00.000Z",
        "by": {
          "id": "text",
          "name": "text",
          "icon": "text",
          "revision": 1
        }
      },
      "invitationAcceptedAt": "2026-01-01T00:00:00.000Z"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "email": "text",
    "status": "text",
    "phone": {
      "prefix": "text",
      "number": "text"
    },
    "firstName": "text",
    "lastName": "text",
    "lastLoginAt": "2026-01-01T00:00:00.000Z",
    "settings": {
      "cultureCode": "text",
      "dateFormat": "text",
      "languageCode": "text",
      "numberFormat": {
        "decimalSeparator": "text",
        "groupSeparator": "text"
      },
      "timeFormat": "text",
      "timeZone": "text",
      "optOuts": {
        "objectTypes": [
          "text"
        ]
      }
    },
    "accounts": [
      {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1,
        "type": "Client",
        "status": "Active"
      }
    ],
    "currentAccount": {
      "id": "text",
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active"
    }
  }
}

Creates a new contact.