Couple Relationship Note

Description

The Couple Relationship Note resource defines the interface for a note. The Couple Relationship Note resource is to be considered an embedded resource, and any links to this resource are to be treated as embedded links.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

Parameters

Name Type Description
X-Reason header Header giving the reason for changing or deleting a note.
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
crid path The id of the couple relationship.
nid path The id of the note.
access_token query The id of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.

Operations

GET - Read a note.

Status Codes
200 Upon a successful read.
404 If the requested note is not found.
429 If the request was throttled.

POST - Update a note.

Status Codes
204 The update was successful.
404 If the requested note is not found.
429 If the request was throttled.

DELETE - Delete a note.

Status Codes
204 The delete was successful.
404 If the requested note is not found.
429 If the request was throttled.

Example Requests

Read Couple Relationship Note How to read a note on a couple relationship.
Delete Couple Relationship Note How to read a note on a couple relationship.