Subscriber Aliases API

GET

/v1/aliases/{subscriber_id}

(subscriber)

List Aliases for a subscriber.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	ID of the subscriber the alias of which are to be fetched	X
page	query	integer	Page Number (default 1)

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
alias	body	string	Unique text string lable of alias
creation_time	body	string	Timestamp of when alias was created
id	body	string	Unique ID of alias
inactive_purge	body	integer	Number of hours that the alias can be inactive (disconnected) before it's automatically purged
last_seen	body	string	Timestamp of last time alias was active
purge_if_seen	body	boolean	If true the Alias will only be purged after it has been active, if false the alias will be purged regardless
subscriber_id	body	string	Unique ID of subscriber to which alias belongs
virtual_id	body	string	Unique ID of vertual server to which alias belongs

Response Example

{
    "payload": [
        {
            "id": "1692bdca-ca46-11ee-b962-ddbef08e6d9d",
            "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
            "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
            "alias": "alias1",
            "inactive_purge": 5,
            "purge_if_seen": false,
            "last_seen": null,
            "creation_time": "2024-02-13T08:01:27+00:00"
        },
        {
            "id": "1ce92dda-ca46-11ee-b962-ddbef08e6d9d",
            "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
            "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
            "alias": "alias2",
            "inactive_purge": 8,
            "purge_if_seen": false,
            "last_seen": null,
            "creation_time": "2024-02-13T08:01:37+00:00"
        },
        {
            "id": "230299c2-ca46-11ee-b962-ddbef08e6d9d",
            "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
            "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
            "alias": "alias3",
            "inactive_purge": 1,
            "purge_if_seen": true,
            "last_seen": null,
            "creation_time": "2024-02-13T08:01:47+00:00"
        }
    ],
    "metadata": {
        "records": 3,
        "page": 1,
        "pages": 10,
        "per_page": 10
    }
}

POST

/v1/alias/{subscriber_id}

(subscriber)

Add Alias for a subscriber.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	ID of the subscriber the alias will be created	X
alias	body	string	Text string label of alias
purge_if_seen	body	boolean	If true alias cannot be purged until it has been active

Request Example

{
    "alias": "alias_TEST",
    "inactive_purge": 1,
    "purge_if_seen": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
alias	body	string	Unique text string lable of alias
creation_time	body	string	Timestamp of when alias was created
id	body	string	Unique ID of alias
inactive_purge	body	integer	Number of hours that the alias can be inactive (disconnected) before it's automatically purged
last_seen	body	string	Timestamp of last time alias was active
purge_if_seen	body	boolean	If true the Alias will only be purged after it has been active, if false the alias will be purged regardless
subscriber_id	body	string	Unique ID of subscriber to which alias belongs
virtual_id	body	string	Unique ID of vertual server to which alias belongs

Response Example

{
    "id": "7dcf542c-ca4a-11ee-b962-ddbef08e6d9d",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
    "alias": "alias_TEST",
    "inactive_purge": 1,
    "purge_if_seen": true,
    "last_seen": null,
    "creation_time": "2024-02-13T08:32:58+00:00"
}

GET

/v1/alias/{alias_id}

(subscriber)

Get Alias by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
alias_id	url	string	ID of the alias that will be retrieved	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
alias	body	string	Unique text string lable of alias
creation_time	body	string	Timestamp of when alias was created
id	body	string	Unique ID of alias
inactive_purge	body	integer	Number of hours that the alias can be inactive (disconnected) before it's automatically purged
last_seen	body	string	Timestamp of last time alias was active
purge_if_seen	body	boolean	If true the Alias will only be purged after it has been active, if false the alias will be purged regardless
subscriber_id	body	string	Unique ID of subscriber to which alias belongs
virtual_id	body	string	Unique ID of vertual server to which alias belongs

Response Example

{
    "id": "7dcf542c-ca4a-11ee-b962-ddbef08e6d9d",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
    "alias": "alias_TEST",
    "inactive_purge": 1,
    "purge_if_seen": true,
    "last_seen": null,
    "creation_time": "2024-02-13T08:32:58+00:00"
}

DELETE

/v1/alias/{alias_id}

(subscriber)

Remove Alias by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
alias_id	url	string	ID of the alias that will be removed	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
alias	body	string	Unique text string lable of alias
creation_time	body	string	Timestamp of when alias was created
id	body	string	Unique ID of alias
inactive_purge	body	integer	Number of hours that the alias can be inactive (disconnected) before it's automatically purged
last_seen	body	string	Timestamp of last time alias was active
purge_if_seen	body	boolean	If true the Alias will only be purged after it has been active, if false the alias will be purged regardless
subscriber_id	body	string	Unique ID of subscriber to which alias belongs
virtual_id	body	string	Unique ID of vertual server to which alias belongs

Response Example

{
    "id": "7dcf542c-ca4a-11ee-b962-ddbef08e6d9d",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
    "alias": "alias_TEST",
    "inactive_purge": 1,
    "purge_if_seen": true,
    "last_seen": null,
    "creation_time": "2024-02-13T08:32:58+00:00"
}

PUT

/v1/alias/{alias_id}

(subscriber)

Edit Alias by ID.

Service
subscriber

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
alias_id	url	string	ID of the alias will be updated	X
alias	body	string	Text string label of alias
purge_if_seen	body	boolean	If true alias cannot be purged until it has been active

Request Example

{
    "alias": "alias_UPDATED",
    "inactive_purge": 1,
    "purge_if_seen": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
alias	body	string	Unique text string lable of alias
creation_time	body	string	Timestamp of when alias was created
id	body	string	Unique ID of alias
inactive_purge	body	integer	Number of hours that the alias can be inactive (disconnected) before it's automatically purged
last_seen	body	string	Timestamp of last time alias was active
purge_if_seen	body	boolean	If true the Alias will only be purged after it has been active, if false the alias will be purged regardless
subscriber_id	body	string	Unique ID of subscriber to which alias belongs
virtual_id	body	string	Unique ID of vertual server to which alias belongs

Response Example

{
    "id": "7dcf542c-ca4a-11ee-b962-ddbef08e6d9d",
    "subscriber_id": "2c621ccc-c9dd-11ee-b885-ddbef08e6d9d",
    "virtual_id": "0ba81d12-3202-4019-95b7-7d7e14f98703",
    "alias": "alias_UPDATED",
    "inactive_purge": 1,
    "purge_if_seen": true,
    "last_seen": null,
    "creation_time": "2024-02-13T08:32:58+00:00"
}

Navigation

Subscriber Aliases API