Relay SMS Platform
Relay SMS API

User

Endpoint

Current user profile management

Get current user profile

GET
https://api.relay.works
/v1/user/me

Get current user profile › Responses

Current user profile

  • idstring · uuid
  • emailstring · email

    The authenticated user's own email address, returned in full. PII masking policy applies to logs and monitoring but not to first-party profile responses.

  • namestring
  • workspace_idstring · uuid
  • created_atstring · date-time

Update current user profile

PUT
https://api.relay.works
/v1/user/me

Currently supports updating phone_number only. Email changes require the Cognito authentication flow via the dashboard and cannot be performed via API key.

Update current user profile › Request Body

  • phone_numberstring

    User phone number in E.164 format.

Update current user profile › Responses

Updated user profile

  • idstring · uuid
  • emailstring · email

    The authenticated user's own email address, returned in full. PII masking policy applies to logs and monitoring but not to first-party profile responses.

  • namestring
  • workspace_idstring · uuid
  • created_atstring · date-time
AnalyticsWorkspace