> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/channel-address.md).
# Channel address
A channel reaches the outside through its **addresses**: an `INBOUND` address is where messages arrive, an `OUTBOUND` address is where they are sent from. A channel holds at most one of each.
An outbound address may only be used once the tenant has proven that it owns it.
## Give a channel an address
> Gives a channel an address. \`direction\` is \`INBOUND\` for the address messages arrive at and \`OUTBOUND\`\
> for the one they are sent from; \`type\` is \`EMAIL\`, \`PHONE\`, \`TOKEN\` or \`URL\`, and \`value\` is the\
> address itself.\
> \
> An \*\*outbound\*\* address that is not a \`URL\` may only be used once the tenant has proven that it owns\
> it: without a verified claim on that address the request is answered with \`403\`. Inbound addresses\
> carry no such requirement.\
> \
> A channel holds at most one identity per direction — adding a second one for the same direction\
> replaces it. The answer is the channel, so the caller sees the result in one step.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A channel reaches the outside through its **addresses**: an `INBOUND` address is where messages\narrive, an `OUTBOUND` address is where they are sent from. A channel holds at most one of each.\n\nAn outbound address may only be used once the tenant has proven that it owns it.\n","name":"channel_identity"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.AddChannelIdentityRequest":{"properties":{"direction":{"$ref":"#/components/schemas/domain.ChannelIdentityDirection"},"type":{"$ref":"#/components/schemas/domain.IdentityType"},"value":{"type":"string"}},"required":["direction","type","value"],"type":"object"},"domain.ChannelIdentityDirection":{"enum":["","INBOUND","OUTBOUND"],"type":"string"},"domain.IdentityType":{"enum":["","EMAIL","PHONE","TOKEN","URL"],"type":"string"},"v1.AddChannelIdentityResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.Channel"}},"type":"object"},"domain.Channel":{"properties":{"active":{"type":"boolean"},"createdAt":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ChannelKind"},"name":{"type":"string"},"purpose":{"$ref":"#/components/schemas/domain.ChannelPurpose"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"updatedAt":{"type":"string"}},"type":"object"},"domain.ChannelKind":{"enum":["","EMAIL","WEBHOOK","TEAMS","SMS","WHATSAPP","WEBCHAT","NOTICE"],"type":"string"},"domain.ChannelPurpose":{"enum":["","THREAD","TICKET","NOTIFICATION"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/channels/{channelId}/identities":{"post":{"description":"Gives a channel an address. `direction` is `INBOUND` for the address messages arrive at and `OUTBOUND`\nfor the one they are sent from; `type` is `EMAIL`, `PHONE`, `TOKEN` or `URL`, and `value` is the\naddress itself.\n\nAn **outbound** address that is not a `URL` may only be used once the tenant has proven that it owns\nit: without a verified claim on that address the request is answered with `403`. Inbound addresses\ncarry no such requirement.\n\nA channel holds at most one identity per direction — adding a second one for the same direction\nreplaces it. The answer is the channel, so the caller sees the result in one step.\n","operationId":"addChannelIdentity","parameters":[{"description":"Channel id","in":"path","name":"channelId","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.AddChannelIdentityRequest","summary":"request","description":"Address to bind"}]}}},"description":"Address to bind","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.AddChannelIdentityResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Give a channel an address","tags":["channel_identity"]}}}}
```
## Take an address away from a channel
> Takes an address away from a channel. The direction in the path says which one — \`INBOUND\` or\
> \`OUTBOUND\`. The answer is the channel without that identity.\
> \
> A channel without an inbound identity receives nothing; without an outbound one it cannot send.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A channel reaches the outside through its **addresses**: an `INBOUND` address is where messages\narrive, an `OUTBOUND` address is where they are sent from. A channel holds at most one of each.\n\nAn outbound address may only be used once the tenant has proven that it owns it.\n","name":"channel_identity"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.DeleteChannelIdentityResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.Channel"}},"type":"object"},"domain.Channel":{"properties":{"active":{"type":"boolean"},"createdAt":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ChannelKind"},"name":{"type":"string"},"purpose":{"$ref":"#/components/schemas/domain.ChannelPurpose"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"updatedAt":{"type":"string"}},"type":"object"},"domain.ChannelKind":{"enum":["","EMAIL","WEBHOOK","TEAMS","SMS","WHATSAPP","WEBCHAT","NOTICE"],"type":"string"},"domain.ChannelPurpose":{"enum":["","THREAD","TICKET","NOTIFICATION"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/channels/{channelId}/identities/{direction}":{"delete":{"description":"Takes an address away from a channel. The direction in the path says which one — `INBOUND` or\n`OUTBOUND`. The answer is the channel without that identity.\n\nA channel without an inbound identity receives nothing; without an outbound one it cannot send.\n","operationId":"deleteChannelIdentity","parameters":[{"description":"Channel id","in":"path","name":"channelId","required":true,"schema":{"type":"integer"}},{"description":"INBOUND or OUTBOUND","in":"path","name":"direction","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.DeleteChannelIdentityResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Take an address away from a channel","tags":["channel_identity"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://hub.equipme.io/development/api-reference-app/channel-address.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.