Links a verified pseudonymous handle to a phone number

POST

/api/v1/websites/{website_id}/phone_identities

const url = 'https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"handle":"v1_b3d76bcae89b6053b23e30d007e534b3","phone_number":"+61411222333","environment":"development"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dashboard.dealerstudio.com.au/api/v1/websites/example/phone_identities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "handle": "v1_b3d76bcae89b6053b23e30d007e534b3", "phone_number": "+61411222333", "environment": "development" }'

Called by a dealership website after a successful SMS OTP verification. The mapping is keyed on the website and the handle, and is upserted idempotently.

Authorizations

Bearer

Parameters

Path Parameters

website_id

required

string

Website ID

Request Body

application/json

object

handle

required

string

Example

v1_b3d76bcae89b6053b23e30d007e534b3

phone_number

required

string

Example

+61411222333

environment

required

string

Allowed values: development preview production

Example

production

Responses

201

Handle linked

application/json

object

linked

boolean

Example

{
  "linked": true
}

401

Missing or insufficient API key

422

Handle is malformed