Request annulment of unused numbers (same body as R4)

POST

/companies/{companyId}/ncf-annulments

curl --request POST \
  --url https://acme.gravitastec.com/api/v1/companies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ncf-annulments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{}'

Authorizations

• oauth2

Parameters

Path Parameters

companyId

required

string format: uuid

Header Parameters

Idempotency-Key

required

string

<= 64 characters

Request Body^required

Media typeapplication/json

object

Example ^generated

{}

Responses

202

Accepted

404

Not found or outside the credential scope

Media typeapplication/problem+json

object

type

string

title

string

status

integer

code

string

errors

Array<object>

object

path

string

message

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

409

Numbers_not_available