v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Users

Update a User's Email Address

Updates attributes of a user's email address.

Allowed Updates

Set an email address as primary (must already be confirmed). - Mark an email as verified (must already be confirmed).

Returns

Returns the updated email address in a JSON object with a data key.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes.

patch/users/{user_id}/settings/emails/{email_id}/

Path parameters

user_idstring required

The unique identifier of the user. Example: abc123

email_idstring required

The unique identifier of the email address. Example: 1a2b3c

Request body

Example request

{
  "data": {
    "type": "user-emails"
  }
}

Response

Successfully updated the email address.

idstring required

The unique identifier of the user entity.

typestring required

The type identifier of the user entity (users).

Example response

{
  "data": {
    "type": "users",
    "id": "{user_id}",
    "attributes": {
      "full_name": "Casey M. Rollins",
      "middle_names": "Marie",
      "social": {
        "github": [
          "https://github.com/caseyrollins"
        ],
        "twitter": [
          "https://twitter.com/crollins"
        ]
      },
      "employment": [
        {
          "title": "Data Scientist",
          "institution": "Open Science Framework",
          "department": "Engineering",
          "startYear": 2018,
          "startMonth": 5,
          "ongoing": true
        }
      ],
      "education": [
        {
          "degree": "MS in Computer Science",
          "institution": "University of Somewhere",
          "department": "Computer Science",
          "startYear": 2014,
          "startMonth": 9,
          "endYear": 2016,
          "endMonth": 6,
          "ongoing": false
        }
      ]
    }
  }
}