User Additional Email Recipients

List User Additional Email Recipients

Endpoint

GET/user_additional_email_recipients

Return Object

UserAdditionalEmailRecipient[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.

Additional Arguments

Example Request

curl "https://app.files.com/api/rest/v1/user_additional_email_recipients.json?user_id=1" \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "user_id": 1,
    "workspace_id": 1,
    "email": "user-copy@example.com",
    "created_at": "2000-01-01T01:00:00Z"
  }
]

Show User Additional Email Recipient

Endpoint

GET/user_additional_email_recipients/{id}

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		User Additional Email Recipient ID.

Example Request

curl https://app.files.com/api/rest/v1/user_additional_email_recipients/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "user-copy@example.com",
  "created_at": "2000-01-01T01:00:00Z"
}

Create User Additional Email Recipient

Endpoint

POST/user_additional_email_recipients

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
email
string
Required		Additional email recipient address

Example Request

curl https://app.files.com/api/rest/v1/user_additional_email_recipients.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"user_id":1,"email":"user-copy@example.com"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "user-copy@example.com",
  "created_at": "2000-01-01T01:00:00Z"
}

Update User Additional Email Recipient

Endpoint

PATCH/user_additional_email_recipients/{id}

Return Object

UserAdditionalEmailRecipient

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		User Additional Email Recipient ID.
email
string		Additional email recipient address

Example Request

curl https://app.files.com/api/rest/v1/user_additional_email_recipients/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"email":"user-copy@example.com"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "user-copy@example.com",
  "created_at": "2000-01-01T01:00:00Z"
}

Delete User Additional Email Recipient

Endpoint

DELETE/user_additional_email_recipients/{id}

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		User Additional Email Recipient ID.

Example Request

curl https://app.files.com/api/rest/v1/user_additional_email_recipients/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The UserAdditionalEmailRecipient Object

Some of the endpoints above return a UserAdditionalEmailRecipient object. The attributes of this object are listed below.

AttributeDescription
id
int64		User additional email recipient ID
user_id
int64		User ID
workspace_id
int64		Workspace ID (0 for default workspace).
email
string		Additional email recipient address
created_at
date-time		Created at date/time

Example UserAdditionalEmailRecipient Object

{
  "id": 1,
  "user_id": 1,
  "workspace_id": 1,
  "email": "user-copy@example.com",
  "created_at": "2000-01-01T01:00:00Z"
}