Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

Workflow: Change Email Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/AUser ID
emailBodyYESStringN/AEmail Address Format (JSON Schema Validation)New Email

...


Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": "..."
}

...


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[405],
        "details":[
            {
                "code":405,
                "message":"Unable to find User. Please try again."
            }
        ]
    }
}



Error Codes

 



Code
Description
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
411invalid user id provided
412You have provided the same existing email address


Example (CURL)

...