Move a relationship type
Put a type somewhere else inside its category, so the ones you use most sit at the top of the picker.
A type moves inside the category it is filed under, and only the types of that category are renumbered from 1, retired ones counted among them. A position past the end puts the type last rather than being refused.
To move a type into a different category, reword it and send the category you want instead. This endpoint only changes the order.
Parameters
Sent as JSON. Anything not listed here is ignored.
The id of the type. A path that is not a uuid answers 404 without a query being run.
Where the type should sit inside its category, counting from 1.
Returns
The relationship type object in its new place.
The type.
Always relationship_type. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
The category the type is filed under. It groups the list and the picker and has no other effect: moving a type between categories never changes what the product does with it.
What the link is called: Parent / Child, Sibling, Colleague. A type the product supplied reads in the language you ask for, until somebody rewrites it, after which their words stand in every language. Up to 255 characters, reduced to plain text.
How the first person relates to the second. In a Parent / Child link the first person is the Parent. It is read in the same way the name is.
How the second person relates to the first. A symmetric type carries the same word here as in role_a, and rewording the two never swaps the people over: the first role stays on the first person of every relationship already written.
Whether both people read the same word, as Friend does, rather than a different one on each side, as Parent / Child does. It is frozen once the product supplied the type or a relationship uses it, because turning it round would rewrite what people wrote years ago.
Either genealogy_parentage, which feeds the family tree, or romantic, which feeds romantic history, or null. It is attached to the supplied type itself rather than to its name or its category, so renaming one or moving it elsewhere changes the words on screen and nothing more. A type you invent never acquires one.
Where the type sits inside its category, counting from 1. Retired types are numbered along with the rest.
Whether the product supplied the type with the account. A supplied type may be reworded, moved and retired, never deleted, and its direction never changes.
Whether the type is offered when a new relationship is written. False stops it being chosen again and touches nothing already written.
How many relationships are written with this type, across every vault of your account. A relationship in the bin is not counted. It decides both whether the type may be deleted and whether its direction may still move.
When the type was added, as a count of seconds since 1970 rather than a written date.
When it last changed, as a count of seconds. Equal to created_at until it first changes.
Where to find this record.
The absolute address this record is read from.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.