Skip to content

Connect a Phone Number

This page documents the API endpoint for connecting a phone number for artists on the In Process protocol. After connection, a verification SMS message will be sent to the provided phone number.

Overview

Artists can connect their phone number to enable SMS-based features and notifications.

  1. An SMS verification message is automatically sent to the provided phone number.


    For example:

    Someone is trying to connect this phone number to the artist profile for sweetman.eth on In Process. If this was you, please reply 'yes'. If this was not you, please ignore this message.

  2. If the artist replies "yes", the artist's phone number will be verified.

  3. With a verified phone number the artist can create new Moments via SMS.

Endpoint

POST https://inprocess.world/api/phones

Authentication

Include an API key in the x-api-key header for authorization:

x-api-key: <artist_api_key>
Show more

See Create an Artist API Key for how to create API keys.

Request Body

Send a JSON object with the following fields:

{
  "phone_number": "string" // Phone number in E.164 format (e.g., "+1234567890")
}

Body Parameters

NameTypeRequiredDescription
phone_numberstringYesPhone number in E.164 format (e.g., "+1234567890" or "+14155552671")

Example Requests

cURL
curl -X POST https://inprocess.world/api/phones \
  -H "Content-Type: application/json" \
  -H "x-api-key: art_sk_3fnm4...f6w4" \
  -d '{
    "phone_number": "+14155552671"
  }'

Example Response

Success Response

{
  "success": true,
  "message": "Phone number connected and verification message sent"
}

Response Fields

NameTypeDescription
successbooleanIndicates whether the operation was successful
messagestringA descriptive message about the operation result

Error Responses

Validation Error (400)

If the request body is invalid or the phone number format is incorrect:

{
  "message": "Invalid request body"
}

Server Error (500)

If an error occurs during phone number connection or SMS sending:

{
  "message": "Failed to connect phone number"
}

Notes

  • Phone numbers should be provided in E.164 format (international format with country code, e.g., "+1234567890")