Skip to main content

Delete typeTwoResource relationship

DELETE 
https://apis.<domain>/resources/typeTwoResources/:id/relationships/:related_field/

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Delete a typeOneResource associated with the typeTwoResource.

Authorization Action:

resource:typeOneResources:delete

Request​

Path Parameters

    ids stringrequired

    Globally unique ids (UUID4)

    related_field stringrequired

Body

    data objectrequired
    oneOf
  • Array [
    • type typerequired

    The type member is used to describe resource objects that share common attributes and relationships.

    id idrequired

    Each resource object’s type and id pair MUST identify a single, unique resource.

    meta object
    property name* any
  • ]

Responses​

Schema
    meta object
    property name* any
curl -L -X DELETE 'https://apis.<domain>/resources/typeTwoResources/:id/relationships/:related_field/' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "data": {}
}'
Request Collapse all
Base URL
https://apis.<domain>
Auth
Parameters
— pathrequired
— pathrequired
Body
{

  "data": {}

}