Manage organization
Important requirement
This API requires you to have active paid services. These API's does not work with the sandbox environment.
Before using these API's, you need to fetch the organization ID from another API request.
Headers
All requests in this section will have the same headers.
Authorization*
String
API Key. Required*.
Content-Type*
String
application/json
Organization details
The behaviour/response may vary depending on which organization's API key is used.
If you're using an API key from the Default organization (the first organization in your account), you can get a response for all organizations in your account, like admin access.
If you are using an API key from other organizations, you can only get a response related to that specific organization. You can't access other organizations.
Use this method to get a list of sender names related to a specific organization
GET https://a.loopmessage.com/api/v1/organizations/details/{id}/
Path Parameters
id*
String
Sender pool ID
Response example
Update organization
Important requirements! This API requires you to use an API Key from the Default organization (the first organization in your account)
PATCH https://a.loopmessage.com/api/v1/organizations/details/{id}/
Request body
Need to send only the fields that you need to change. It's not necessary to send all possible values from the list above.
name
String
New name for the organization.
website
String
Your organization or product webpage.
support_url
String
A webpage where your users can get support related to your services.
country
String
Your organization country. Value should be in ISO-2 format. For example: US for USA, CA for Canada, GB for United kingdom.
webhook_url
String
Optional. URL that will be used to fire webhooks related to this organization. This field required to receive an API key in the response.
webhook_header
String
Optional. Value that will be included in the webhooks Authorization header.
Response
Response will be the same as in the GET method, but with updated values.
Delete organization
Before delete organization, there should be no active sender names assigned to this organization.
Important requirements! This API requires you to use an API Key from the Default organization (the first organization in your account)
DELETE https://a.loopmessage.com/api/v1/organizations/details/{id}/
Response
Last updated