Below, please find the endpoints and examples:

Release Telephone Numbers:

• Endpoint:

•  https://api.smartcarrier.io/v2/release?

• Method:

• GET

• Parameters:

• TelephoneNumber: 10 or 11 digit telephone number.

• Immediate:
  

• Optional Parameter

• 0 or false: Default if Immediate parameter not included. Number will be released at a predetermined time
  

• 1 or true: Releases the number immediately

• Headers:

• x-api-key: Your API key.

• Sample Request:
  

• Regular Release:
  

• https://api.smartcarrier.io/v2/release?TelephoneNumber=3155551212
  

• or https://api.smartcarrier.io/v2/release?TelephoneNumber=3155551212&Immediate=0
  

• Immediate Release:
  

• https://api.smartcarrier.io/v2/release?TelephoneNumber=3155551212&Immediate=1

• Response
• {
  

  "AccountGuid": "ecad22d2-22ee-4a94-b7e8-f33cd5a2485f",

  "TelephoneNumber": "3155551212",

  "RequestCost": "$0.00",

  "Immediate": false,

  "DateTimeRequested": "2023-10-23T21:09:46.9894542Z",

  "ResponseCode": 200,

  "ResponseMessage": "Success"

  }

  
  

• AccountGuid: the account's unique identifier.

• TelephoneNumber:  The telephone number requested for release.

• RequestCost: Whether or not the release incurred a cost due to an immediate release.

• DateTimeRequested:  The date and time of the request.
  

• ResponseMessage: A friendly representation of the request's status.

• ResponseCode:

• 200: Successful

• 503: ResponseMessage will contain the reason.