Change a contact method's address or number. A new value must be verified again.

PATCH

/user/{user_id}/contact_method/{contact_method_id}

curl --request PATCH \
  --url https://api.siteqwality.com/user/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/contact_method/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "details": "example" }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

user_id

required

string format: uuid

User identifier

contact_method_id

required

string format: uuid

Contact method identifier

Request Body ^required

Media type application/json

The type is fixed; send a new method to change it.

object

details

required

Same shapes as create. SMS takes {phone_number, country} (ISO 3166-1 alpha-2), {phone_number, country_code}, {e164} or a + number.

Example ^generated

{
  "details": "example"
}

Responses

200

Contact method updated. A changed address or number is unverified, unless it is the user’s sign-in email.

Media type application/json

object

id

required

string format: uuid

user_id

required

string format: uuid

type

required

string

Allowed values: email sms phone_call slack_dm mobile_push

details

required

Stored details with a Slack DM token masked.

verified

required

boolean

created_at

required

string format: date-time

integration_id

A Slack DM linked from /oncall sends through this Slack integration; no token is stored.

string | null format: uuid

linked_via

The linked Slack integration’s name, while it is connected.

string | null

Example

{
  "type": "email"
}

400

Invalid details, a phone number without a country or invalid for its country, or a changed Slack member on a Slack DM linked from Slack

401

Missing or invalid authentication

403

Only the user or an admin may change a user’s contact methods

404

Contact method not found

500

Internal server error