Profile changes

Use these methods to view a history of client profile changes.

GET[host]/api/v2/clients/{clientId}/changes

Get a profile change history

GET[host]/api/v2/clients/{clientId}/changes/{changeId}

Get profile change details

Get a profile change history

Use this method to obtain the log of client profile changes.

Note

Currently, you can get only the log of changes made to clients’ email address.

Use a separate method to get details about a specific profile change record.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The identifier of a client for which you want to get a profile change history.

Query parameters:

The following filter parameter is required for this method:

type required

The change type. Possible values:

  • email

The following sorting parameter is available for this method:

createTime

The date and time when a change was made to a client profile.

Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/clients/{clientId}/changes

curl --location -g --request GET 'https://host.name/api/v2/clients/1/changes?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[type]=email' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes an array of Profile Change objects providing information about the change records matching the request parameters.

Get profile change details

Use this method to obtain detailed information about a specified profile change record.

Use a separate method to get a profile change history.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The identifier of a client for which you want to get a profile change history.

changeId required

The identifier of a change record.

Query parameters:

The following filter parameter is required for this method:

type required

The change type. Possible values:

  • email

GET[host]/api/v2/clients/{clientId}/changes{changeId}

curl --location -g --request GET 'https://host.name/api/v2/clients/1/changes/1?filter[type]=email' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes a Profile Change object providing information about the specified change record.