/profile/email_setting

This endpoint allows you to manage profile email settings.

Request Headers

Content-Type: application/json
Accept: application/json
Authorization: Bearer access_token
Host: example.org
Cookie: 

Request Example

curl "http://shares.example.com/profile/email_setting" -d '{"share_authorization":true,"project_authorization":false,"transfer_completion":true}' -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer access_tokenquot; \
    -H "Host: example.org" \
    -H "Cookie: "

Request Parameters (POST and PUT)

Name Required/Optional Type Description
share_authorization Optional acceptance Share authorization
project_authorization Optional acceptance Project authorization
transfer_completion Optional acceptance Transfer completion

Success Response Codes

Method Code
GET 200 OK
POST 201 Created
PUT 200 OK
DELETE 204 No Content

Error Response Codes

Description of error is included in response body.

Method Error Reason
PUT 422 Unprocessable Entity Submitted parameter with invalid or empty value

Response Attributes

Name Type Description
share_authorization boolean Share authorization
project_authorization boolean Project authorization
transfer_completion boolean Transfer completion

Show email settings

GET /profile/email_setting

Request Example

curl -g "http://shares.example.com/profile/email_setting" -X GET

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"3d34500755a4bd17124cdf0501107fe1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fbd0235b-3d80-49c9-a5bd-ad9f860a0645
X-Runtime: 0.008445
Content-Length: 84

Success Response Example

200 OK
{
"share_authorization": true,
"project_authorization": true,
"transfer_completion": true
}


Create email settings

POST /profile/email_setting

Request Example

curl "http://shares.example.com/profile/email_setting" -d '{"share_authorization":true,"project_authorization":false,"transfer_completion":true}' -X POST

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"37149fd8c15aba8461fa3aa86f119b2d"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 62e5a6ec-fd05-4e32-9817-0bf04d95453b
X-Runtime: 0.018141
Content-Length: 85

Success Response Example

201 Created
{
  "share_authorization": true,
  "project_authorization": false,
  "transfer_completion": true
}


Update email settings

PUT /profile/email_setting

Request Example

curl "http://shares.example.com/profile/email_setting" -d '{"share_authorization":false}' -X PUT

Response Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
Content-Type: application/json; charset=utf-8
ETag: W/"2fa930c7933172407517ea8cb148ef68"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c8000f32-3a4c-4290-b625-caec2751b6a2
X-Runtime: 0.019410
Content-Length: 85

Success Response Example

200 OK
{
  "share_authorization": false,
  "project_authorization": true,
  "transfer_completion": true
}

Error Response Example

422 Unprocessable Entity
{
   "errors": {
   "share_authorization": [
      "is not included in the list"
      ]
   }
}


Delete email settings

DELETE /profile/email_setting

Request Example

curl "http://shares.example.com/profile/email_setting" -d '' -X DELETE

Response Headers

X-Frame-Options: SAMEORIGIN
    X-XSS-Protection: 1; mode=block
    X-Content-Type-Options: nosniff
    Content-Security-Policy: script-src 'self' 'unsafe-inline' 'unsafe-eval' https://local.connectme.us https://d3gcli72yxqn2z.cloudfront.net http://d3gcli72yxqn2z.cloudfront.net
    Cache-Control: no-cache
    X-Request-Id: 1f6015bf-5cb5-4467-b96c-74812e421ce4
    X-Runtime: 0.010640

Success Response Example

204 No Content

Video player

Video

×