X-email header requirements
SafeSend APIs require an x-email header that identifies an authorized SafeSend user for each API call.
Header requirement
Include the
x-email
header in every SafeSend API request. Set the header value to the email address of the SafeSend user who makes the request. The API call fails if the request doesn't include a valid email address or if SafeSend can't find the specified user.
Authorized users
Use the email address of a SafeSend user who has one of the following roles or group memberships:
- Suite user with the API Developer role
- System administrator
- User in the administrator user group
API request error codes
Code | Description | Resolution |
|---|---|---|
200 | The request succeeded. | No action is needed. |
400 Bad Request | The request doesn't include an x-email header, contains an invalid email value, or identifies a user that SafeSend can't find. | Include a valid x-email header for an authorized SafeSend user. |
401 Unauthorized | The request doesn't include an Authorization header, or the access token is invalid or expired. | Include a valid bearer token in the Authorization header. Generate a new token if the current token has expired. |
403 Forbidden | Authentication succeeded, but the user doesn't have permission to call the API. | Verify that the user identified in the x-email header has the required SafeSend role or group membership. |