REST APIUser Management Notification

POST

Registers a new device token for the authenticated user. If the token already exists, updates its association or last set time as appropriate. Used for enabling push notifications to the user's device.

Header Params

  • request-id string

Body Params

object

  • deviceToken string required

    at least 1 characters

  • provider string enum required
    fcm
  • platform string enum required
    ANDROIDIOS
  • appId string required

    at least 1 characters

Responses

201
Device token added

Response Body

object

  • deviceToken string required
  • platform string enum required
    ANDROIDIOS
  • provider string enum required
    fcm
  • appId string required
  • bitgoUserId string required
  • message string required
400
Invalid device token request body

Response Body

object

Bad request error response
  • name string enum required
    Error code
    ValidationFailedIllegalArgumentBadRequestDataIntegrityErrorNotImplementedErrorRETRIGGER_RATE_LIMITEDUSER_CREATION_FAILEDUSER_FALLBACK_FAILED
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    400
500
Unexpected error

Response Body

object

Internal server error response
  • name string enum required
    Error code
    UnexpectedErrorThirdPartyErrorDatabaseErrorUSER_FALLBACK_TIMEOUT
  • error string required
    Human-readable error message
  • status integer enum int32 required
    HTTP status code
    500