Sign in

v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
Profile

Update a profile

Updates the profile and billing details of the authenticated account.

put/v1/profile

Request body

additional_infostring

Additional information associated with the account.

contactsstring

Email associated with the account.

default_short_link_endpointstring

Default short link endpoint.

first_namestring

Account owner's first name.

last_namestring

Account owner's last name.

phonestring

Account owner's phone number

sms_relay_urlstring

Callback URL to forward inbound SMS to.

dlr_relay_urlstring

Callback URL to forward message delivery reports (DLRs) to.

time_zonestring

Timezone configured on the account.

job_titlestring

Account owner's job title.

Example request

{
  "time_zone": "UTC",
  "company_info": {
    "industry": "telecommunications"
  }
}

Response

Returns the updated profile.

idinteger required

Account ID.

emailstring required

Email associated with the account.

first_namestring nullable required

Account owner's first name.

last_namestring nullable required

Account owner's last name.

phonestring nullable required

Account owner's phone number.

additional_infostring nullable required

Additional info associated with the account.

contact_emailstring nullable required

Additional email address for billing notifications.

timezonestring required

Timezone configured on the account.

job_titlestring nullable required

Account owner's job title.

default_short_link_endpointstring nullable required

Default short link endpoint.

Example response

{
  "id": 1,
  "email": "info@awesome.com",
  "first_name": "Jason",
  "last_name": "Androux",
  "phone": "13291019312",
  "additional_info": "Additional info",
  "contact_email": "billing@awesome.com",
  "timezone": "Pacific/Wallis",
  "job_title": "Manager",
  "default_short_link_endpoint": "https://short.examples.com",
  "default_destinations": [
    {
      "transport": "sms",
      "value": "https://webhook.address.com/inboundSMS"
    }
  ],
  "company_info": {
    "name": "Awesome company",
    "industry": "telecommunications",
    "address": "Baker street",
    "attn_contact_name": "James Scott",
    "vat_number": "VAT123456789",
    "country": {
      "country_name": "United States",
      "country_id": 1
    }
  }
}