Loading

DFS Contact Group Services API (latest)

Download OpenAPI specification:Download

Contains functionality around contact groups.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

ContactGroupAccess

Validate whether a contact has access to a contact group related entity (e.g. Legal entities, Accounts)

Validates whether a contact has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:
path Parameters
contactId
required
integer <int32>

Contact id

entityId
required
integer <int32>

Entity id

entityType
required
string (EntityTypeLinkedWithContactGroupKey)
Enum: "Account" "LegalEntity" "Portfolio" "PortfolioProposal"

Entity type

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contact-groups/contacts/{contactId}/{entityType}/{entityId}/access
https://example-host/v1.0/contact-groups/contacts/{contactId}/{entityType}/{entityId}/access

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hasAccess": true
}

Validate whether a member has access to a contact group related entity (e.g. Legal entities, Accounts)

Validates whether a member has access to a contact group related entity (e.g. Legal entities, Accounts)

Authorizations:
path Parameters
identityId
required
string <uuid>

Identity id

entityId
required
integer <int32>

Entity id

entityType
required
string (EntityTypeLinkedWithContactGroupKey)
Enum: "Account" "LegalEntity" "Portfolio" "PortfolioProposal"

Entity type

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v1.0/contact-groups/identities/{identityId}/{entityType}/{entityId}/access
https://example-host/v1.0/contact-groups/identities/{identityId}/{entityType}/{entityId}/access

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "hasAccess": false
}

ContactGroupManagement

Delete a contact group

Deletes a contact group.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

delete/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}
https://example-host/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get contact group details

Gets contact group details.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}
https://example-host/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "groupId": 0,
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts":
    [
    ]
}

Modify a contact group

Modifies a contact group.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

contactGroupId
required
integer <int32>

The ID of the contact group

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

groupName
string Nullable
groupExternalId
string Nullable
customAttributes
string Nullable
contacts
Array of objects (Api.ContactGroupManagement.ModifyContactGroup.Contact) Nullable

Responses

204

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

put/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}
https://example-host/v2.0/contacts/{contactId}/contactgroups/{contactGroupId}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get contact contact groups details

Gets contact groups associated with a contact.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/v2.0/contacts/{contactId}/contactgroups
https://example-host/v2.0/contacts/{contactId}/contactgroups

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "groups":
    [
    ]
}

Create a new contact group

Creates a new contact group.

Authorizations:
path Parameters
contactId
required
integer <int32>

The ID of the contact

header Parameters
Accept-Language
string

The ISO 639-1 language to use for localizable data.

Request Body schema:

The parameter DTO.

groupName
string Nullable
groupExternalId
string Nullable
customAttributes
string Nullable
contacts
Array of objects (Api.ContactGroupManagement.CreateContactGroup.Contact) Nullable

Responses

201

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v2.0/contacts/{contactId}/contactgroups
https://example-host/v2.0/contacts/{contactId}/contactgroups

Request samples

Content type
Copy
Expand all Collapse all
{
  • "groupName": "string",
  • "groupExternalId": "string",
  • "customAttributes": "string",
  • "contacts":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0
}