Add phone number and start verification process

POST /v2/users/{userId}/phone/

API version

v2

Request method

POST

Operation ID

user-add-phone-number

---

Request

• userIdstring

  required

  self or the id of a user.

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"phoneNumber":"+491701234567"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/string/phone

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.addPhoneNumber({
  "userId": "string",
  "data": {
    "phoneNumber": "+491701234567"
  }
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\AddPhoneNumber\AddPhoneNumberRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\User\AddPhoneNumber\AddPhoneNumberRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// AddPhoneNumberRequestBody to learn how to construct a valid instance
$body = new AddPhoneNumberRequestBody(/* TODO: ... */);

$request = (new AddPhoneNumberRequest(
  userId: "string",
  body: $body
));
$response = $client->user()->addPhoneNumber($request);

var_dump($response->getBody();