update-number | Mediahawk docs

Update static number

Path Parameters

service_number string required
Possible values: Value must match regular expression ^[0-9]{1,14}$
The service number in E.164 format (without leading +)

application/json

Request Body

name string required
start_date string required
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to starts. Formatted as ISO 8601 without time. Required if run_continuously is false.
end_date string
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to ends. Formatted as ISO 8601 without time. Required if run_continuously is false.
run_continuously boolean required
When set to true, the number will be always available. When set to false, the number will be available until end_date
campaign_id integer required
metadata object
department_id integer required
ID from the /metadata/departments requests.
channel_id integer required
ID from the /metadata/channels requests.
media_owner_id integer required
ID from the /metadata/media_owners requests.
cost object
amount double required
frequency string required
Possible values: [One-off, Daily, Weekly, Bi-weekly, Monthly, Bi-monthly, Quarterly, Annually]

Responses

application/json

Schema
Example (from schema)

Schema

service_number string
Possible values: Value must match regular expression ^[0-9]{1,14}$
name string
start_date string
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to starts. Formatted as ISO 8601 without time. Required if run_continuously is false.
end_date string
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to ends. Formatted as ISO 8601 without time. Required if run_continuously is false.
run_continuously boolean
When set to true, the number will be always available. When set to false, the number will be available until end_date
prefix object
prefix string
Possible values: Value must match regular expression [1-9]{1,3}[0-9]+
Local area code for a number
name string
country string
ISO 3166-1 alpha-2 country code
campaign object
id integer
name string
start_date string
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to starts. Formatted as ISO 8601 without time. Required if run_continuously is false.
end_date string
Possible values: Value must match regular expression ^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[0-1])$
Date when the campaign the number belongs to ends. Formatted as ISO 8601 without time. Required if run_continuously is false.
run_continuously boolean
When set to true, the number will be always available. When set to false, the number will be available until end_date
metadata object
department object
name string
Possible values: <= 80 characters
media_owner object
name string
Possible values: <= 80 characters
channel object
name string
Possible values: <= 80 characters
cost object
amount double
frequency string
Possible values: [One-off, Daily, Weekly, Bi-weekly, Monthly, Bi-monthly, Quarterly, Annually]

{
  "service_number": "441234567890",
  "name": "Sales campaign",
  "start_date": "2022-07-07",
  "end_date": "2022-08-07",
  "run_continuously": "false",
  "prefix": {
    "prefix": "441234",
    "name": "01234 - Bedford",
    "country": "GB"
  },
  "campaign": {
    "id": 1,
    "name": "Sales campaign",
    "start_date": "2022-07-07",
    "end_date": "2022-08-07",
    "run_continuously": "false"
  },
  "metadata": {
    "department": {
      "name": "Sales"
    },
    "media_owner": {
      "name": "Billboard"
    },
    "channel": {
      "name": "Paid"
    },
    "cost": {
      "amount": "3.33",
      "frequency": "Daily"
    }
  }
}

Update static number​

Update static number