Delete a profile

DELETE

/v1/profiles/{key}

curl --request DELETE \
  --url https://api.inboxcnx.com/v1/profiles/example \
  --header 'Authorization: Bearer <token>'

Deletes a profile that no grant references. The default profile cannot be deleted; archive a profile that grants still use.

Requires the write:application scope.

Authorizations

• apiKey

Parameters

Path Parameters

key

required

string

/^[a-z0-9][a-z0-9_-]{0,31}$/

Responses

204

Deleted

403

The credential lacks the write:application scope

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

No such profile

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

The profile is the default or is referenced by grants

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}