Skip to main content
POST
/
api
/
v1
/
profiles
/
{profile_id}
/
phone_numbers
Create a phone number for a profile
curl --request POST \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{profile_id}/phone_numbers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "phone_number",
    "attributes": {
      "label": "home",
      "phone_number": "+14155559012",
      "effective_from": "2023-12-25",
      "external_id": "EXT-12345"
    },
    "relationships": {
      "profile": {
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "phone_number",
    "attributes": {
      "label": "home",
      "phone_number": "+14155559012",
      "effective_from": "2023-12-25",
      "custom_fields": {},
      "external_id": "EXT-12345",
      "effective_to": "2023-12-25"
    },
    "relationships": {
      "profile": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Path Parameters

​
profile_id
string
required

Profile UUID

Body

application/vnd.api+json
​
data
object
required

Response

phone number created

​
data
object
required